查询告警列表

最近更新时间:2019-05-23 11:11:55

1. 接口描述

查询告警列表,在产生告警后,可以调用此接口查询告警。

域名:monitor.api.qcloud.com
接口名:DescribeAlarmList

2. 输入参数

参数名称 必选 类型 描述
namespace String 名字空间,调用 查询命名空间(DescribeNamespace)接口查询,若不填写查询所有命名空间下的告警
metricName String 指标名,调用 查询指标(DescribeMetric)接口查询,若不填写,查询所有指标下的告警
dimensions.n.name String 维度组合的 key 部分,与 value 共同标识一个您关注的具体的对象,若不填则查询所有对象的告警,调用 查询指标对象列表(DescribeObjects)接口查询
dimensions.n.value String 维度组合的value部分,调用 查询指标对象列表(DescribeObjects)接口查询
starttime datetime 起始时间默认时间为当天的00:00
endtime datetime 结束时间默认时间为当前时间
offset Int 偏移量,默认为0即从第一条告警开始显示
limit Int 显示的行数,默认为30,从偏移offset开始,取limit条告警

填写 metricName 时,需要填写 namespace。
其中 dimensions.n.name 和 dimensions.n.value 匹配成对出现,当填写 dimensions.n.name 和 dimensions.n.value时需要填写 metricName 和 namespace。

3. 输出参数

参数名称 类型 描述
code Int 错误码,0:成功,其他值表示失败,详见错误码页面的 公共错误码 页面
message String 错误信息,当成功时为空
data Array 当有额外的返回信息时,有该字段

data的内容:

参数名称 类型 描述
alarmList Array 告警列表
total Int 告警的条数

alarmList的内容:

参数名称 类型 描述
metricName String 告警相关的指标名
namespace String 告警相关的命名空间
object String 告警相关的对象字符串
occurTime String 告警发生时间,上报数据第一次满足告警条件时的时间。例如用户指定磁盘利用率在10分钟内其平均值大于80%触发告警,告警时间11:00表示在10:50-11:00内,磁盘使用率的最大值大于80%
recoverTime String 告警恢复时间,当告警未恢复时,恢复时间为0000-00-00 00:00:00,查询告警列表时,告警依旧没有恢复,告警恢复时间的值为0000-00-00 00:00:00,表示当前告警未恢复。上报的数据不再满足告警条件,告警恢复时间为数据恢复正常时的时间
sendStatus Int 告警是否发送成功0成功,非0未成功
okStatus Int 是否恢复 0:未恢复,1:已恢复, 2:超时恢复
smsSendCnt Int 告警短信的发送条数
content String 告警内容
alarmRuleId String 告警对应的规则 ID

4. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?Action=DescribeAlarmList
&<公共请求参数>
&namespace=cvm
&metricName=diskusage

输出

{
    "code": 0,
    "message": "",
    "data": {
        "alarmList": [
            {
                "metricName": "diskusage",
                "namespace": "cvm",
                "object": "ip=172.31.58.160&diskname=disk1",
                "occurTime": "2016-02-23 11:10:00",
                "recoverTime": "0000-00-00 00:00:00",
                "sendStatus": "0",
                "okStatus": "0",
                "smsSendCnt": "1",
                "alarmRuleId": "policy-f3h1bxvcsb",
                "content": "'机器磁盘使用率'300秒粒度统计求max>=80'%'已持续达300秒"
            }
        ],
        "total": "1"
    }
}

由结果可知,在11:05:00-11:10:00期间,磁盘 ip=172.31.58.160&diskname=disk1 使用率最大值大于80%。