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

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

功能介绍

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

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:customAlarmTemplates:listAssociatedAlarms

    List

    -

    g:EnterpriseProjectId

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

template_id

是

String

参数解释：

告警模板的ID。

约束限制：

不涉及。

取值范围：

以at开头，后跟字母、数字，长度为[2,64]个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

分页偏移量

约束限制：

不涉及

取值范围：

整数，[0,10000]

默认取值：

0

limit

否

Integer

参数解释：

分页大小

约束限制：

不涉及

取值范围：

整数，[1,100]

默认取值：

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

alarms

Array of alarms objects

告警规则列表

count

Integer

参数解释：

告警规则列表总数。

取值范围：

取值范围为0-1000.
表5 alarms

参数

参数类型

描述

alarm_id

String

参数解释：

告警模板的ID。

取值范围：

以al开头，后跟22位由字母或数字组成的字符串。长度为24个字符。

name

String

参数解释：

告警规则名称。

取值范围：

只能为字母、数字、汉字、-或_，长度为[1,128]个字符

description

String

参数解释：

告警规则描述。

取值范围：

长度为[0,256]个字符。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

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

/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

系统内部错误

错误码

请参见错误码。

相关文档