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

查询告警模板详情

功能介绍

查询告警模板详情

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户ID

template_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

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]。

默认取值

空字符串。

policies

Array of AlarmTemplatePolicies objects

告警模板策略列表

表4 AlarmTemplatePolicies

参数

参数类型

描述

namespace

String

参数解释

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

约束限制

不涉及。

取值范围

格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。

默认取值

不涉及。

dimension_name

String

参数解释

资源维度。

约束限制

事件告警模板DimensionName为空

取值范围

必须以字母开头,多维度用","分隔,只能包含0-9/a-z/A-Z/_/-,每个维度的最大长度为32。目前最大支持4个维度。举例:单维度场景:instance_id;多维度场景:instance_id,disk

默认取值

不涉及。

metric_name

String

参数解释

资源的监控指标名称,各服务的指标名称可查看:“服务指标名称”。

约束限制

不涉及。

取值范围

必须以字母开头,只能包含0-9/a-z/A-Z/_/-。字符长度最短为1,最大为96。如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率。

默认取值

不涉及。

period

Integer

告警条件判断周期,单位为秒

枚举值:

  • 0

  • 1

  • 300

  • 1200

  • 3600

  • 14400

  • 86400

filter

String

数据聚合方式

正则匹配:^(average|variance|min|max|sum)$

comparison_operator

String

参数解释

阈值符号。

约束限制

指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave; 事件告警可以使用的阈值符号为>、>=、<、<=、=、!=。

取值范围

支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。

默认取值

不涉及。

value

Number

告警阈值。单一阈值时value和alarm_level配对使用,当hierarchical_value和value同时使用时以hierarchical_value为准

取值范围:

0-2.34854258277383E108

hierarchical_value

HierarchicalValue object

参数解释

多层级告警阈值。

约束限制

当hierarchical_value和value同时使用时以hierarchical_value为准。

创建或修改告警规则以下2种场景只支持设置一个阈值:

1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。

2.告警类型为事件告警的场景。

unit

String

数据的单位字符串,长度不超过32

count

Integer

参数解释

告警连续触发次数。

约束限制

不涉及。

取值范围

事件告警时参数值为1~180(包括1和180);指标告警和站点告警时,次数采用枚举值,枚举值分别为:1、2、3、4、5、10、15、30、60、90、120、180。

默认取值

不涉及。

alarm_level

Integer

参数解释

告警级别。

约束限制

不涉及。

取值范围

只能为1、2、3、4。

  • 1为紧急

  • 2为重要

  • 3为次要

  • 4为提示

默认取值

不涉及。

suppress_duration

Integer

告警抑制周期,单位为秒,当告警抑制周期为0时,仅发送一次告警

枚举值:

  • 0

  • 300

  • 600

  • 900

  • 1800

  • 3600

  • 10800

  • 21600

  • 43200

  • 86400

selected_unit

String

参数解释

用户在页面中选择的指标单位, 用于后续指标数据回显和计算。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表5 HierarchicalValue

参数

参数类型

描述

critical

Double

参数解释

紧急级别的阈值。

约束限制

不涉及。

取值范围

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值

不涉及。

取值范围:

-1.7976931348623156E108-1.7976931348623156E108

major

Double

参数解释

重要级别的阈值。

约束限制

不涉及。

取值范围

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值

不涉及。

取值范围:

-1.7976931348623156E108-1.7976931348623156E108

minor

Double

参数解释

次要级别的阈值。

约束限制

不涉及。

取值范围

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值

不涉及。

取值范围:

-1.7976931348623156E108-1.7976931348623156E108

info

Double

参数解释

提示级别的阈值。

约束限制

不涉及。

取值范围

[-1.7976931348623157e+108, 1.7976931348623157e+108]

默认取值

不涉及。

取值范围:

-1.7976931348623156E108-1.7976931348623156E108

状态码: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

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

请求异常内部业务状态码

error_msg

String

请求异常信息

request_id

String

请求ID

请求示例

查询告警模板详情

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

响应示例

状态码:200

OK

{
  "template_id" : "at1628592157541dB1klWgY6",
  "template_name" : "my_template",
  "template_type" : "custom",
  "create_time" : "2006-01-02T15:04:05.000Z",
  "template_description" : "hello world",
  "policies" : [ {
    "namespace" : "SYS.ECS",
    "dimension_name" : "instance_id",
    "metric_name" : "cpu_util",
    "period" : 300,
    "filter" : "sum",
    "comparison_operator" : ">",
    "value" : 2,
    "hierarchical_value" : {
      "major" : 85
    },
    "unit" : "bit/s",
    "selected_unit" : "",
    "count" : 2,
    "alarm_level" : 2,
    "suppress_duration" : 300
  } ]
}

状态码

状态码

描述

200

OK

400

参数校验失败

401

未认证

403

认证鉴权失败

404

资源不存在

500

系统内部错误

错误码

请参见错误码

相关文档