文档首页/云监控服务 CES/API参考/API V2/告警模板/查询告警模板列表 - ListAlarmTemplates
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

查询告警模板列表 - ListAlarmTemplates

功能介绍

查询告警模板列表

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ces:customAlarmTemplates:list

    List

    -

    g:EnterpriseProjectId

    -

    -

URI

GET /v2/{project_id}/alarm-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

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

namespace

否

String

查询服务的命名空间，各服务命名空间请参考“服务命名空间”

dim_name

否

String

资源维度，必须以字母开头，多维度用","分隔，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32

template_type

否

String

模板类型(system代表默认指标模板，custom代表自定义指标模板，system_event代表默认事件模板，custom_event代表自定义事件模板，system_custom_event代表全部事件模板),不传返回全部指标模板

template_name

否

String

告警模板的名称，以字母或汉字开头，可包含字母、数字、汉字、_、-，长度范围[1,128]，支持模糊匹配

product_name

否

String

（已废弃）支持按照产品名称粒度进行查询告警模板，产品名称一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id"

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

alarm_templates

Array of AlarmTemplates objects

告警模板列表

count

Integer

告警模板记录总数

表5 AlarmTemplates

参数

参数类型

描述

template_id

String

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

template_name

String

参数解释：

告警模板的名称。

约束限制：

不涉及。

取值范围：

以字母或汉字开头，可包含字母、数字、汉字、_、-，长度为[1,128]个字符。

默认取值：

不涉及。

template_type

String

模板类型(custom代表默认自定义模板，system代表系统模板)

create_time

String

告警模板的创建时间

template_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?offset=0&limit=100

响应示例

状态码：200

OK

{
  "alarm_templates" : [ {
    "template_id" : "at1628592157541dB1klWgY6",
    "template_name" : "my_template",
    "template_type" : "custom",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "template_description" : "hello world"
  } ],
  "count" : 100
}

状态码

状态码

描述

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

500

系统内部错误

错误码

请参见错误码。

父主题：告警模板