5.3 告警规则管理
5.3.1 查询告警规则列表
功能介绍
查询告警规则列表，可以指定分页条件限制结果数量，可以指定排序规则。
调试
您可以在API Explorer中调试该接口。
URI
GET /V1.0/{project_id}/alarms
● 参数说明
表5-14 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
表5-15 参数说明
名称 参数类型 说明
alarms Array of
objects 告警规则列表。
表5-16 查询检索参数
名称 是否必选 参数类型 说明
start 否 String 分页起始值，内容为alarm_id。
limit 否 Integer 取值范围(0,100]，默认值为100 用于限制结果数据条数。
名称 是否必选 参数类型 说明
order 否 String 用于标识结果排序方法，时间戳
排序。
取值说明，默认值为desc。
● asc：升序
● desc：降序 enterprise_pr
oject_id 否 String 企业项目ID，默认值为
all_granted_eps。表示所有企业 项目。
● 当查询所有企业项目时，配置 为：all_granted_eps。
● 当需要查询某个企业项目时，
配置为对应的企业项目ID，请 参考获取企业项目ID。
● 样例
请求样例一：查询当前告警规则列表。
GET https://{云监控的endpoint}/V1.0/{project_id}/alarms
请求样例二：查询告警规则列表，从alarm_id为al1441967036681YkazZ0deN开 始，结果按时间戳降序保留10条数据。
GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?
start=al1441967036681YkazZ0deN&limit=10&order=desc
请求样例三：查询所有企业项目下的告警规则列表，从alarm_id为 al1441967036681YkazZ0deN开始，结果按时间戳降序保留10条数据。
GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?
start=al1441967036681YkazZ0deN&limit=10&order=desc&enterprise_project_id=all_granted_eps
请求消息
无
响应消息
● 响应参数
表5-17 响应参数
名称 参数类型 说明
metric_alarms Array of
objects 告警对象列表。
详细参数请参见表5-18。
meta_data Object 查询结果元数据信息，包括分页信息等。
详细参数请参见表5-25。
表5-18 metric_alarms 字段数据结构说明
名称 参数类型 说明
alarm_name String 告警名称。
alarm_descripti
on String 告警描述。
metric Object 告警指标。
详细参数请参见表5-19。
condition Object 告警触发条件。
详细参数请参见表5-24。
alarm_enabled Boolean 是否启用该条告警。
alarm_level Integer 告警级别，默认为2，级别为1、2、3、4。分 别对应紧急、重要、次要、提示。
alarm_action_e
nabled Boolean 是否启用该条告警触发的动作。
alarm_actions Array of
objects 告警触发的动作。
详细参数请参见表5-21。
ok_actions Array of
objects 告警恢复触发的动作。
详细参数请参见表5-22。
insufficientdata
_actions Array of
objects 数据不足触发的动作。
详细参数请参见表5-23。
alarm_action_b
egin_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_type String 告警类型。
● 针对事件类型的告警时，告警类型为
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-19 metric 字段数据结构说明
名称 参数类型 说明
namespace String 查询服务的命名空间，各服务命名空间请参考支 持监控的服务列表。
dimensions Array of
objects 指标维度列表。
详细参数请参见表5-20。
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-20 dimensions 字段数据结构说明
名称 参数类型 说明
name String 监控维度名称，例如弹性云服务器的维度为 instance_id。各服务维度请参考支持监控的服务 列表，可参考维度中key字段。
value String 维度取值，例如弹性云服务器的ID。
长度最短为1，最大为256。
表5-21 alarm_actions 字段数据结构说明
名称 参数类型 说明
type String 告警通知类型，取值如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationLi
st Array of
strings 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串。
表5-22 ok_actions 字段数据结构说明
名称 参数类型 说明
type String 告警恢复触发告警通知类型，取值如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificationLi
st Array of
strings 告警状态发生变化时，被通知对象的ID列表。
说明被通知对象的ID列表的参数类型为字符串。
表5-23 insufficientdata_actions 字段数据结构说明
名称 参数类型 说明
type String 数据不足触发告警通知类型，取值为 notification。
notificationLi
st Array of
strings 数据不足触发告警通知时，被通知对象的ID列 表。
表5-24 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。
表5-25 meta_data 字段数据结构说明
名称 参数类型 说明
count Integer 当前返回结果条数。
marker String 下一个开始的标记，用于分页。
如本次查询10条数据，第十条为alarm_id为 1441967036681YkazZ0deN，下次start配置为 al1441967036681YkazZ0deN可从该alarm_id开 始查询。
total Integer 结果总条数。
● 响应样例
"period": 300,
"metric_name": "network_incoming_bytes_aggregate_rate"
},
"meta_data": { "count": 2,
"marker": "al1533031226533nKJexAlbq", "total": 389
} }
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。