5.3 告警规则管理
5.3.5 创建告警规则
功能介绍
创建一条告警规则。
调试
您可以在API Explorer中调试该接口。
URI
POST /V1.0/{project_id}/alarms
● 参数说明
表5-37 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
● 样例
POST https://{云监控的endpoint}/V1.0/{project_id}/alarms
请求消息
● 请求参数
表5-38 请求参数
名称 是否必选 参数类型 说明
alarm_name 是 String 告警名称，只能包含0-9/a-z/A-Z/_/-或汉字，长度1-128。
alarm_descripti
on 否 String 告警描述，长度0-256。
metric 是 Object 告警指标。
详细参数请参见表5-39。
condition 是 Object 告警触发条件。
详细参数请参见表5-44。
alarm_enabled 否 Boolean 是否启用该条告警，默认为true。
alarm_action_e
nabled 否 Boolean 是否启用该条告警触发的动作，默 认为true。
说明若alarm_action_enabled为true，对应 的alarm_actions、
insufficientdata_actions（该参数已废 弃，建议无需配置）、ok_actions至少 有一个不能为空。
若alarm_actions、
insufficientdata_actions（该参数已废 弃，建议无需配置）、ok_actions同时 存在时，notificationList值保持一致。
enterprise_proj
ect_id 否 String 企业项目ID。
默认值为0，表示默认的企业项目 default。
如何查询企业项目ID，请参考获取 企业项目ID。
alarm_level 否 Integer 告警级别，默认为2，级别为1、
2、3、4。分别对应紧急、重要、
次要、提示。
alarm_type 否 String 告警类型。
● 针对事件类型的告警时，告警类 型为EVENT.SYS（系统事件）或 EVENT.CUSTOM（自定义事 件）。
● 针对资源分组的告警时，告警类 型为RESOURCE_GROUP。
● 针对指定资源的告警时，告警类 型为MULTI_INSTANCE。
名称 是否必选 参数类型 说明 alarm_actions 否 Arrays of
objects 告警触发的动作。
结构样例如下：
{
"type":
"notification","notificationList":
["urn:smn:region:
68438a86d98e427e907e0097b7e3 5d47:sd"]
}
详细参数请参见表5-41。
ok_actions 否 Arrays of
objects 告警恢复触发的动作。
结构如下：
{ "type":
"notification","notificationList":
["urn:smn:region:
68438a86d98e427e907e0097b7e3 5d47:sd"] }
详细参数请参见表5-42。
insufficientdata
_actions 否 Arrays of
objects 数据不足触发的动作（该参数已废 弃，建议无需配置）。
结构如下：
{ "type":
"notification","notificationList":
["urn:smn:region:
68438a86d98e427e907e0097b7e3 5d47:sd"] }
详细参数请参见表5-43。
表5-39 metric 字段数据结构说明
名称 是否必选 参数类型 说明
namespace 是 String 服务的命名空间，各服务命名空间 请参考支持监控的服务列表。
格式为service.item；service和item 必须是字符串，必须以字母开头，
只能包含0-9/a-z/A-Z/_，
service.item总长度最短为3，最大 为32。
说明当alarm_type为（EVENT.SYS|
EVENT.CUSTOM）时允许为空。
名称 是否必选 参数类型 说明 dimensions 否 Arrays of
objects 指标维度列表，如果不使用
resource_group_id，则dimensions 值必填。
详细参数请参见表5-40。
metric_name 是 String 指标名称，必须以字母开头，只能 包含0-9/a-z/A-Z/_，长度最短为 1，最大为64。
具体指标名请参见查询指标列表中 查询出的指标名。
resource_group
_id 否 String 创建告警规则时选择的资源分组
ID，如：
rg1603786526428bWbVmk4rP 说明
如果根据资源分组创建告警规则，则 resource_group_id不能为空，
dimensions中至少指定一个维度信息，
name不能为空，且alarm_type值为 RESOURCE_GROUP。
表5-40 dimensions 字段数据结构说明
名称 是否必选 参数类型 说明
name 是 String 监控维度名称，例如弹性云服务器
的维度为instance_id。各服务维度 请参考支持监控的服务列表，可参 考维度中key字段。
必须以字母开头，只能包含0-9/a-z/A-Z/_/-，长度最短为1，最大为 32。
value 是 String 维度取值，例如弹性云服务器的 ID。
必须以字母或数字开头，只能包含 0-9/a-z/A-Z/_/-，长度最短为1，最 大为256。
表5-41 alarm_actions 字段数据结构说明
名称 是否必选 参数类型 说明
type 是 String 告警通知类型，取值如下：
● notification：通知。
● autoscaling：弹性伸缩。
名称 是否必选 参数类型 说明 notificationList 是 Arrays of
strings 告警状态发生变化时，被通知对象 的列表。通知对象ID最多可以配置
● 若要使Auto Scaling告警规则生 效，必须绑定伸缩策略，具体操作 请参考创建弹性伸缩策略。
● 若alarm_action_enabled为true，
对应的alarm_actions、
insufficientdata_actions（该参数 已废弃，建议无需配置）、
ok_actions至少有一个不能为空。
● 若alarm_actions、
insufficientdata_actions（该参数
表5-42 ok_actions 字段数据结构说明
名 是否必选 参数类型 说明
type 是 String 告警恢复触发告警通知类型，取值
如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationList 是 Arrays of
objects 告警状态发生变化时，被通知对象 的列表，通知对象列表为字符串。
列表最长为5。topicUrn可从SMN 获取，具体操作请参考查询Topic列 表。
说明若alarm_action_enabled为true，对应 的alarm_actions、
表5-43 insufficientdata_actions 字段数据结构说明
名称 是否必选 参数类型 说明
type 是 String 告警恢复触发告警通知类型，取值
如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationList 是 Arrays of
objects 告警状态发生变化时，被通知对象 的列表。通知对象ID最多可以配置 5个。topicUrn可从SMN获取，具 体操作请参考查询Topic列表。
说明
● 若alarm_action_enabled为true，
对应的alarm_actions、
insufficientdata_actions（该参数 已废弃，建议无需配置）、
ok_actions至少有一个不能为空。
● 若alarm_actions、
insufficientdata_actions（该参数 已废弃，建议无需配置）、
ok_actions同时存在时，
notificationList值保持一致。
● 被通知对象的ID列表的参数类型为 字符串。
表5-44 condition 字段数据结构说明
名称 是否必选 参数类型 说明
period 是 Integer 告警条件判断周期，单位为秒，支 持的值为1，300，1200，3600，
14400，86400。
说明
● 当period设置为1时，表示以原始 的指标数据判断告警。
● 当alarm_type为（EVENT.SYS|
EVENT.CUSTOM）时允许为0。
filter 是 String 数据聚合的方式，支持max、
min、average、sum、variance，
分别表示最大值、最小值、平均 值、求和值、方差值。
comparison_o
perator 是 String 告警阈值的比较条件，可以是>、
=、<、>=、<=。
名称 是否必选 参数类型 说明
value 是 Double 告警阈值，取值范围[0, Number.MAX_VALUE]，
unit 否 String 数据的单位，最大长度为32位。
count 是 Integer 触发告警连续发生次数，取值范围 [1, 5]。
suppress_dura
tion 否 Integer 发送告警的周期。值可为0、300、
600、900、1800、3600、
{ "alarm_name": "alarm-rp0E", "alarm_description": "", "metric": {
"metric_name": "network_outgoing_bytes_rate_inband"
},
"alarm_enabled": true, "alarm_action_enabled": true, "alarm_level": 2,
"alarm_actions": [ {
"type": "notification",
"notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
} ],
"ok_actions": [ {
"type": "notification",
"notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
} ],
"insufficientdata_actions": [ {
"type": "notification",
"notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
} ] }
响应消息
● 响应参数
表5-45 响应参数
名称 参数类
型 说明
alarm_id String 告警规则的ID。
● 响应样例
{ "alarm_id":"al1450321795427dR8p5mQBo"
}
返回值
● 正常 201
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。