5.3 告警规则管理
5.3.11 修改告警规则
{
"metric_name": "mem_util", "condition": {
"period": 1, "filter": "average",
"comparison_operator": ">=", "value": 90,
"unit": "%", "count": 3,
"suppress_duration": 600 },
"alarm_action_enabled": false, "alarm_level": 2
} ]}
响应消息
无消息体。
返回值
● 正常 204
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。
5.3.11 修改告警规则
功能介绍
修改告警规则。
调试
您可以在API Explorer中调试该接口。
URI
PUT /V1.0/{project_id}/alarms/{alarm_id}
● 参数说明
表5-72 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
alarm_id 是 告警规则的ID。
● 样例
PUT https://{云监控的endpoint}/V1.0/{project_id}/alarms/{alarm_id}
请求消息
● 请求参数
表5-73 参数说明
名称 是
否 必 选
类型 说明
alarm_nam
e 否 String 告警名称，只能包含0-9/a-z/A-Z/_/-或汉 字。
alarm_descr
iption 否 String 告警描述，长度0-256。
condition 否 Condition
object 告警规则设置的告警策略。
alarm_actio
n_enabled 否 Boolean 是否启用该条告警触发的动作，默认为 true。
说明若alarm_action_enabled为true，对应的 alarm_actions、ok_actions至少有一个不能为 空。若alarm_actions、ok_actions同时存在 时，notificationList值保持一致。
alarm_level 否 Integer 告警级别。默认为2，级别为1、2、3、
4。分别对应紧急、重要、次要、提示。
名称 是 否 必 选
类型 说明
alarm_type 否 String 告警类型。支持的枚举类型：
EVENT.SYS：针对系统事件的告警规则。
{ "type": "notification","notificationList":
["urn:smn:southchina:
objects 数据不足触发的动作（该参数已废弃，建 议无需配置）。
ok_actions 否 Arrays of
objects 告警恢复触发的动作。
表5-74 condition 字段数据结构说明
名称 是
period 是 Integer 监控数据粒度。
取值范围：
● 1，实时数据
● 300，5分钟粒度
● 1200，20分钟粒度
● 3600，1小时粒度
● 14400，4小时粒度
● 86400，1天粒度
名称 是 否 必 选
参数类 型
说明
filter 是 String 数据聚合方式，支持的聚合方式如下:
● average：聚合周期内指标数据的平均值。
● max：聚合周期内指标数据的最大值。
● min：聚合周期内指标数据的最小值。
● sum：聚合周期内指标数据的求和值。
● variance：聚合周期内指标数据的方差。
comparison_
operator 是 String 告警阈值的比较条件，可以是>、=、<、>=、
<=。
value 是 Double 告警阈值。取值范围[0, Number.MAX_VALUE]，
Number.MAX_VALUE值为
1.7976931348623157e+108。具体阈值取值 请参见附录中各服务监控指标中取值范围，如 支持监控的服务列表中ECS的CPU使用率 cpu_util取值范围可配置80。
unit 否 String 数据的单位，最大长度为32位。
count 是 Integer 触发告警的连续发生次数，取值范围[1, 5]。
suppress_du
ration 否 integer 发送告警的周期。值可为0、300、600、
900、1800、3600、10800、21600、
43200、86400。0表示只告警一次，300表示 每5分钟告警一次，600表示每10分钟告警一 次，900表示每15分钟告警一次，1800表示每 30分钟告警一次，3600表示每1小时告警一 次，10800表示每3小时告警一次，21600表示 每6小时告警一次，43200表示每12小时告警 一次，86400表示每1天告警一次。
表5-75 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-76 ok_actions 字段数据结构说明
名称 是否必选 参数类型 说明
type 是 String 告警恢复触发告警通知类型，取值
如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationList 是 Arrays of
objects 告警状态发生变化时，被通知对象 的列表，通知对象列表为字符串。
列表最长为5。topicUrn可从SMN 获取，具体操作请参考查询Topic列 表。
说明若alarm_action_enabled为true，对应 的alarm_actions、
表5-77 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（该参数
{ "alarm_name": "alarm-update-test01", "alarm_description": "alarm-update-test01", "condition": {
"comparison_operator": ">=", "count": 3,
"filter": "average", "period": 1, "value": 95 },
"alarm_action_enabled": false, "alarm_level": 2
}
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
返回值 说明
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。