文档首页/ 云监控服务 CES/ API参考/ API V2/ 告警模板关联告警规则/ 查询告警模板关联的告警规则列表
更新时间：2024-10-30 GMT+08:00
查看PDF
分享

查询告警模板关联的告警规则列表

功能介绍

查询告警模板关联的告警规则列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户ID

最小长度：1

最大长度：64

template_id

是

String

告警模板的ID，以at开头，后跟字母、数字，长度最长为64

最小长度：2

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页查询时查询的起始位置，表示从第几条数据开始，默认为0

最小值：0

最大值：10000

limit

否

Integer

查询结果条数的限制值，取值范围为[1,100]，默认值为100

最小值：1

最大值：100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

最小长度：1

最大长度：16384

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

alarms

Array of alarms objects

告警规则列表

数组长度：0 - 100

count

Integer

告警规则列表总数

最小值：0

最大值：1000
表5 alarms

参数

参数类型

描述

alarm_id

String

告警规则ID

正则匹配：^al([0-9A-Za-z]){22}$

name

String

告警规则名称

最小长度：1

最大长度：128

正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

description

String

告警规则描述

最小长度：0

最大长度：256

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

请求示例

查询告警模板关联的告警规则列表

/v2/{project_id}/alarm-templates/{template_id}/association-alarms

响应示例

状态码： 200

OK

{
  "alarms" : [ {
    "alarm_id" : "al12345678901234567890",
    "name" : "test",
    "description" : "告警规则列表"
  } ],
  "count" : 100
}

状态码

状态码

描述

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

500

系统内部错误

错误码

请参见错误码。