本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 告警模板/ 查询告警模板详情

查询告警模板详情

更新时间：2025-04-14 GMT+08:00

查看PDF

功能介绍

查询告警模板详情

调试

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户ID 最小长度：1 最大长度：64
template_id	是	String	告警模板的ID，以at开头，后跟字母、数字，长度最长为64 最小长度：2 最大长度：64

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	租户Token 最小长度：1 最大长度：16384

响应参数

状态码：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	告警模板策略列表数组长度：1 - 1000

表4 AlarmTemplatePolicies
参数	参数类型	描述
namespace	String	查询服务的命名空间，各服务命名空间请参考“服务命名空间”
dimension_name	String	资源维度，必须以字母开头，多维度用","分割，只能包含0-9/a-z/A-Z/_/-，每个维度的最大长度为32, 事件告警模板DimensionName为空
metric_name	String	资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标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 最小长度：0 最大长度：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为提示
suppress_duration	Integer	告警抑制周期，单位为秒，当告警抑制周期为0时，仅发送一次告警枚举值： 0 300 600 900 1800 3600 10800 21600 43200 86400
selected_unit	String	用户在页面中选择的指标单位，用于后续指标数据回显和计算

表5 HierarchicalValue
参数	参数类型	描述
critical	Double	紧急级别的阈值最小值：0 最大值：1.7976931348623156E108
major	Double	重要级别的阈值最小值：0 最大值：1.7976931348623156E108
minor	Double	次要级别的阈值最小值：0 最大值：1.7976931348623156E108
info	Double	提示级别的阈值最小值：0 最大值：1.7976931348623156E108

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

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

请求示例

查询告警模板详情

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

响应示例

状态码：200

{
  "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,
    "unit" : "bit/s",
    "count" : 2,
    "alarm_level" : 2,
    "suppress_duration" : 300
  } ]
}

状态码


状态码	描述
200	OK
400	参数校验失败
401	未认证
403	认证鉴权失败
404	资源不存在
500	系统内部错误

错误码

请参见错误码。

父主题： 告警模板

上一篇：查询告警模板列表

下一篇：告警模板关联告警规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询告警模板详情

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈