5.3 告警规则管理
5.3.2 查询单条告警规则信息
}
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。
5.3.2 查询单条告警规则信息
功能介绍
根据告警ID查询告警规则信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /V1.0/{project_id}/alarms/{alarm_id}
● 参数说明
表5-26 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
alarm_id 是 告警规则的ID。
● 样例
GET https://{云监控的endpoint}/V1.0/{project_id}/alarms/al1441967036681YkazZ0deN
请求消息
无
响应消息
● 响应参数
名称 参数类型 说明
metric_alarm
s Array of
objects 告警对象列表。
详细参数请参见表5-27。
表5-27 metric_alarms 字段数据结构说明
名称 参数类型 说明
alarm_name String 告警名称。
alarm_descripti
on String 告警描述。
metric Object 告警指标。
详细参数请参见表5-28。
condition Object 告警触发条件。
详细参数请参见表5-33。
alarm_enabled Boolean 是否启用该条告警。
alarm_level Integer 告警级别，默认为2，级别为1、2、3、4。分别 对应紧急、重要、次要、提示。
名称 参数类型 说明 alarm_type String 告警类型。
● 针对事件类型的告警时，告警类型为
nabled Boolean 是否启用该条告警触发的动作。
alarm_actions Array of
objects 告警触发的动作。
详细参数请参见表5-30。
ok_actions Array of
objects 告警恢复触发的动作。
详细参数请参见表5-31。
insufficientda
ta_actions Array of
objects 数据不足触发的动作。
详细参数请参见表5-32。
alarm_action_
begin_time String 告警规则生效的开始时间，告警规则仅在生效 时间内发送通知消息。
例如alarm_action_begin_time为8:00，
alarm_action_end_time为20:00时，则对应的 告警规则仅在08:00-20:00发送通知消息。
alarm_action_e
nd_time String 告警规则生效的结束时间，告警规则仅在生效 时间内发送通知消息。
例如alarm_action_begin_time为8:00，
alarm_action_end_time为20:00时，则对应的 告警规则仅在08:00-20:00发送通知消息。
alarm_id String 告警规则的ID。
update_time long 告警状态变更的时间，UNIX时间戳，单位毫 秒。
alarm_state String 告警状态，取值说明：
● ok，正常
● alarm，告警
● insufficient_data，数据不足 enterprise_proj
ect_id String 企业项目ID。
● 取值为all_granted_eps时，表示所有企业项 目。
● 取值为0时，表示默认的企业项目default。
表5-28 metric 字段数据结构说明
名称 参数类型 说明
namespace String 查询服务的命名空间，各服务命名空间请参考支 持监控的服务列表。
dimensions Array of
objects 指标维度列表。
详细参数请参见表5-29。
metric_name String 指标ID，例如弹性云服务器的监控指标CPU使用 率，对应的metric_name为cpu_util。各服务监控 指标请参考支持监控的服务列表。
resource_gro
up_id String 创建告警规则时选择的资源分组ID，如：
rg1603786526428bWbVmk4rP resource_gro
up_name String 创建告警规则时选择的资源分组名称，如：
Resource-Group-ECS-01
表5-29 dimensions 字段数据结构说明
名称 参数类型 说明
name String 监控维度名称，例如弹性云服务器的维度为 instance_id。各服务维度请参考支持监控的服务 列表，可参考维度中key字段。
value String 维度取值，例如弹性云服务器的ID。
长度最短为1，最大为256。
表5-30 alarm_actions 字段数据结构说明
名称 参数类型 说明
type String 告警通知类型，取值如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationLi
st Array of
strings 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串。
表5-31 ok_actions 字段数据结构说明
名称 参数类型 说明
type String 告警恢复触发告警通知类型，取值如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationLi
st Array of
strings 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串。
表5-32 insufficientdata_actions 字段数据结构说明
名称 参数类型 说明
type String 告警恢复触发告警通知类型，取值如下：
notification。
notificationLi
st Array of
strings 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串。
表5-33 condition 字段数据结构说明
名称 参数类型 说明
period Integer 告警条件判断周期，单位为秒。
filter String 数据聚合方式，支持的聚合方式如下:
● average：聚合周期内指标数据的平均值。
● max：聚合周期内指标数据的最大值。
● min：聚合周期内指标数据的最小值。
● sum：聚合周期内指标数据的求和值。
● variance：聚合周期内指标数据的方差。
comparison_o
perator 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_dur
ation Integer 发送告警的周期。值可为0、300、600、900、
1800、3600、10800、21600、43200、86400。
{"metric_alarms":
[ {
"alarm_name":"alarm-ipwx", "alarm_description":"", "metric":
{
"namespace":"SYS.ELB", "dimensions":
[ {
"name":"lb_instance_id",
"value":"44d06d10-bce0-4237-86b9-7b4d1e7d5621"
} ],
"metric_name":"m8_out_Bps"
}, "condition":
{
"period":300, "filter":"sum",
"comparison_operator":">=", "value":0,
"unit":"", "count":1 },
"alarm_enabled":true, "alarm_level": 2,
"alarm_action_enabled":true, "alarm_actions":
[ {
"type":"notification",
"notificationList":["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
} ],
"ok_actions":
[ {
"type":"notification",
"notificationList":["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
} ],
"insufficientdata_actions": [ {
"alarm_action_begin_time": "00:00",
"alarm_action_end_time": "23:59", "alarm_id":"al1498096535573r8DNy7Gyk", "update_time":1498100100000,
"alarm_state":"alarm"
} ] }
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。