查询告警规则列表
功能介绍
查询告警规则列表，可以指定分页条件限制结果数量，可以指定排序规则。
URI
GET /V1.0/{project_id}/alarms
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。
约束限制：
不涉及。
取值范围：
字符串的长度必须在 1 到 64个字符之间。
默认取值：
不涉及。
表2 查询检索参数 名称
是否必选
参数类型
说明
start
否
String
参数解释：
分页起始值，内容为alarm_id。
约束限制：
不涉及。
取值范围：
以al开头，后跟22位字母或数字。字符长度为24。
默认取值：
不涉及。
limit
否
Integer
参数解释：
用于限制结果数据条数。
约束限制：
不涉及。
取值范围：
取值范围(0,100]
默认取值：
默认值为100 。
order
否
String
参数解释：
用于标识结果排序方法，按时间戳排序。
约束限制：
不涉及
取值范围：
枚举值：
- asc：升序
- desc：降序
默认取值：
desc
- 样例
请求样例二：查询告警规则列表，从alarm_id为al1441967036681YkazZ0deN开始，结果按时间戳降序保留10条数据。
GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc
请求消息
无
响应消息
- 响应参数
表3 响应参数 名称
参数类型
说明
metric_alarms
Array of objects
参数解释：
告警对象列表。
详细参数请参见表4。
meta_data
Object
参数解释：
查询结果元数据信息，包括分页信息等。
详细参数请参见表10。
表4 metric_alarms字段数据结构说明 名称
参数类型
说明
alarm_name
String
参数解释：
告警名称。
取值范围：
不涉及。
alarm_description
String
参数解释：
告警描述。
取值范围：
不涉及。
metric
Object
参数解释：
告警指标。
详细参数请参见表5。
condition
Object
参数解释：
告警触发条件。
详细参数请参见表9。
alarm_enabled
Boolean
参数解释：
是否启用该条告警。
取值范围：
布尔值。
alarm_level
Integer
参数解释：
告警级别。
取值范围：
级别为1、2、3、4。分别对应紧急、重要、次要、提示。
alarm_action_enabled
Boolean
参数解释：
是否启用该条告警触发的动作。
取值范围：
布尔值。
alarm_actions
Array of objects
参数解释：
告警触发的动作。
详细参数请参见表7。
ok_actions
Array of objects
参数解释：
告警恢复触发的动作。
详细参数请参见表8。
alarm_id
String
参数解释：
告警规则的ID。
取值范围：
以al开头，后跟22个数字或字母。
update_time
Long
参数解释：
告警状态变更的时间，UNIX时间戳，单位毫秒。
取值范围：
不涉及。
alarm_state
String
参数解释：
告警状态。
取值范围：
- ok：正常
- alarm：告警
- insufficient_data：数据不足
表5 metric字段数据结构说明 名称
参数类型
说明
namespace
String
参数解释：
查询服务的命名空间，例如弹性云服务器命名空间。
取值范围：
不涉及。
dimensions
Array of objects
参数解释：
指标维度列表。
详细参数请参见表6。
metric_name
String
参数解释：
指标ID，例如弹性云服务器的监控指标CPU使用率，对应的metric_name为cpu_util。
取值范围：
不涉及。
表6 dimensions字段数据结构说明 名称
参数类型
说明
name
String
参数解释：
监控维度名称，例如弹性云服务器的维度为instance_id，可参考维度中key字段。
取值范围：
不涉及。
value
String
参数解释：
维度取值，例如弹性云服务器ID。
取值范围：
长度最短为1，最大为256。
表7 alarm_actions字段数据结构说明 名称
参数类型
说明
type
String
参数解释：
告警通知类型。
取值范围：- notification：通知。
- autoscaling：弹性伸缩。
notificationList
Array of strings
参数解释：
告警状态发生变化时，被通知对象的列表。
说明：被通知对象的ID列表的参数类型为字符串。
表8 ok_actions字段数据结构说明 名称
参数类型
说明
type
String
参数解释：
告警恢复触发告警通知类型。
取值范围：- notification：通知。
- autoscaling：弹性伸缩。
notificationList
Array of strings
参数解释：
告警状态发生变化时，被通知对象的ID列表。
说明：被通知对象的ID列表的参数类型为字符串。
表9 condition字段数据结构说明 名称
参数类型
说明
period
Integer
参数解释：
告警条件判断周期，单位为秒。
取值范围：
枚举值。
filter
String
参数解释：
数据聚合方式。
取值范围：
- average：聚合周期内指标数据的平均值。
- max：聚合周期内指标数据的最大值。
- min：聚合周期内指标数据的最小值
- sum：聚合周期内指标数据的求和值。
- variance：聚合周期内指标数据的方差。
comparison_operator
String
参数解释：
告警阈值的比较条件。
取值范围：
可以是>、=、<、>=、<=、!=。
value
Double
参数解释：
告警阈值。
具体阈值取值请参见附录中各服务监控指标中取值范围，如监控指标中cpu_util取值范围可配置80。
取值范围：
[0, Number.MAX_VALUE]，Number.MAX_VALUE值为1.7976931348623157e+108。
unit
String
参数解释：
数据的单位。
取值范围：
最大长度为32位。
count
Integer
参数解释：
触发告警连续发生次数。
取值范围：
[1, 5]
- 响应样例
{ "metric_alarms": [ { "alarm_name": "alarm-ttttttt", "alarm_description": "", "metric": { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "07814c0e-59a1-4fcd-a6fb-56f2f6923046" } ], "metric_name": "cpu_util" }, "condition": { "period": 300, "filter": "average", "comparison_operator": ">=", "value": 0, "unit": "%", "count": 3 }, "alarm_enabled": true, "alarm_level": 2, "alarm_action_enabled": false, "alarm_id": "al15330507498596W7vmlGKL", "update_time": 1533050749992, "alarm_state": "alarm" }, { "alarm_name": "alarm-m5rwxxxxxxx", "alarm_description": "", "metric": { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "30f3858d-4377-4514-9081-be5bdbf1392e" } ], "metric_name": "network_incoming_bytes_aggregate_rate" }, "condition": { "period": 300, "filter": "average", "comparison_operator": ">=", "value": 12, "unit": "Byte/s", "count": 3 }, "alarm_enabled": true, "alarm_level": 2, "alarm_action_enabled": true, "alarm_actions": [ { "type": "notification", "notificationList": [ "urn:smn:region:68438a86d98e427e907e0097b7e35d48:test0315" ] } ], "ok_actions": [ { "type": "notification", "notificationList": [ "urn:smn:region:68438a86d98e427e907e0097b7e35d48:test0315" ] } ], "alarm_id": "al1533031226533nKJexAlbq", "update_time": 1533204036276, "alarm_state": "ok" } ], "meta_data": { "count": 2, "marker": "al1533031226533nKJexAlbq", "total": 389 } }
返回值
错误码
请参考返回错误码说明。
