5.3 告警规则管理
5.3.6 创建自定义告警模板
功能介绍
创建自定义告警模板来添加一个或者多个指标的告警规则。
调试
您可以在API Explorer中调试该接口。
URI
POST /V1.0/{project_id}/alarm-template
● 参数说明
表5-46 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
● 样例
POST https://{云监控的endpoint}/V1.0/{project_id}/alarm-template
请求消息
● 请求参数
表5-47 请求参数
名称 是否必选 参数类型 说明
template_name 是 String 自定义告警模板名称,只能包含 0-9/a-z/A-Z/_/-或汉字，长度为 1-128。
template_descr
iption 否 String 自定义告警模板详细描述，长度为 0-256。
namespace 是 String 创建自定义告警模板选择的资源类 型，即服务命名空间，如选择弹性 云服务器，则命名空间为SYS.ECS。
须知
当选择的资源类型为“弹性云服务器中 操作系统监控”，命名空间必须为 SYS.ECS。
名称 是否必选 参数类型 说明 dimension_na
me 是 String 资源类型对应的指标监控维度，选
择弹性云服务器，则维度为云服务 器，dimension_name值为
instance_id。
template_item
s 是 Arrays of
objects 创建自定义告警模板添加一个或者 多个指标的告警规则，目前最多可 增加20组告警规则策略。
表5-48 template_items 字段数据结构说明
名称 是否必选 参数类型 说明
metric_name 是 String 告警模板添加的监控指标，如弹性 云服务器可添加的监控指标为 cpu_util等，各资源的监控指标名 称可查看支持监控的服务列表。
condition 是 Condition
object 创建自定义告警模板的告警策略。
alarm_level 否 Integer 设置告警级别，值为1、2、3、4。
其中1为紧急，2为重要，3为次 要，4为提示。
表5-49 condition 字段数据结构说明
名称 是否必
选
参数类型 说明
comparison_op
erator 是 String 告警阈值的比较条件,可以是>、=、
<、>=、<=。
count 是 Integer 触发告警的连续发生次数，取值范围 [1, 5]。
filter 是 String 数据聚合的方式，支持max、min、
average、sum、variance，分别表示 最大值、最小值、平均值、求和值、
方差值。
period 是 Integer 告警条件判断周期,单位为秒,支持的值 为1,300,1200,3600,14400,86400。
说明当period设置为1时，表示以原始的指标数 据判断告警。当alarm_type为(EVENT.SYS|
EVENT.CUSTOM)时允许为0。
unit 否 String 数据的单位，最大长度为32位。
名称 是否必 选
参数类型 说明
value 是 Double 告警阈值,取值范围[0, Number.MAX_VALUE]， 900, 1800, 3600, 10800, 21600, 43200, 86400。0表示只告警一次，
300表示每5分钟告警一次，600表示
{ "template_name": "alarmTemplate-Test01", "template_description": "创建自定义告警模板", "namespace": "SYS.ECS",
"dimension_name": "instance_id", "template_items": [
{
}
响应消息
● 响应参数
表5-50 响应参数
名称 参数类
型 说明
template_i
d String 告警模板的ID。
● 响应样例
{ "alarm_id":"at1603252280799wLRyGLxnz"
}
返回值
● 正常 201
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。