创建自定义告警模板
功能介绍
创建自定义告警模板
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/alarm-templates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户Token |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
template_name |
是 |
String |
告警模板的名称，以字母或汉字开头，可包含字母、数字、汉字、_、-，长度范围[1,128] |
|
template_type |
否 |
Integer |
自定义告警模板类型 0：指标 2： 事件 枚举值：
|
|
template_description |
否 |
String |
告警模板的描述，长度范围[0,256]，该字段默认值为空字符串 |
|
is_overwrite |
否 |
Boolean |
是否对模板名称已经存在的告警模板进行覆盖。true:覆盖同名告警模板；false：不覆盖，新建告警模板。 默认取值： false |
|
policies |
是 |
Array of Policies objects |
告警模板策略列表 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
告警条件判断周期,单位为秒 枚举值：
|
|
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-1.7976931348623156E108 |
|
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为提示 |
|
suppress_duration |
是 |
Integer |
告警抑制周期，单位为秒，当告警抑制周期为0时，仅发送一次告警 枚举值：
|
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_id |
String |
告警模板的ID，以at开头，后跟字母、数字，长度最长为64 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
请求示例
创建告警模板名称为my_template，告警连续触发次数2次，每5分钟告警一次，告警级别重要的自定义模板。
{
"template_name" : "my_template",
"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
} ]
}响应示例
状态码：201
Created
{
"template_id" : "at1628592157541dB1klWgY6"
}状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
参数校验失败 |
|
401 |
未认证 |
|
403 |
认证鉴权失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
