更新时间:2025-08-26 GMT+08:00
分享

查询告警模板列表

功能介绍

查询告警模板列表

调试

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

URI

GET /v2/{project_id}/alarm-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

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

取值范围:

0-10000

limit

Integer

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

取值范围:

1-100

namespace

String

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

正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$

dim_name

String

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

正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$

template_type

String

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

枚举值:

  • system

  • custom

  • system_event

  • custom_event

  • system_custom_event

template_name

String

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

正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s){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

告警模板记录总数

取值范围:

0-9999999

表5 AlarmTemplates

参数

参数类型

描述

template_id

String

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

template_name

String

参数解释

告警模板的名称。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

template_type

String

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

枚举值:

  • system

  • custom

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

系统内部错误

错误码

请参见错误码

相关文档