接口功能介绍
根据筛选项查询告警规则列表。
接口约束
regionID（资源池）存在。
URI
GET /v4/monitor/query-alarm-rules
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun资源池ID | |
| service | String | 是 | ecs | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | |
| alarmStatus | Integer | 否 | 1 | 本参数表示告警规则状态。取值范围：0：启用中，未触发告警。1：启用中，当前告警状态。2：停用。根据以上范围取值。 | |
| name | String | 否 | test | 规则名称 | |
| page | String | 否 | 1 | 页码，默认1,建议使用pageNo，该参数后续会下线 | |
| pageNo | String | 否 | 1 | 页码，默认为1 | |
| pageSize | Integer | 否 | 10 | 页大小，默认为20 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmRules | Array of Objects | 告警规则 | alarmRule | |
| totalCount | Integer | 总记录数 | 20 | |
| currentCount | Integer | 当前页记录数 | 10 | |
| totalPage | Integer | 总页数 | 2 |
表alarmRule
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleID | String | 告警规则ID | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | |
| triggerID | String | zbx平台的规则ID | 634d170039fa5e04c4a33614 | |
| name | String | 规则名 | 告警规则lyc123 | |
| desc | String | 描述 | test | |
| repeatTimes | Integer | 重复告警通知次数 | 1 | |
| service | String | 服务 | ecs | |
| dimension | String | 维度 | ecs | |
| level | Integer | 报警级别：1灾难告警，2严重告警，3一般告警，4警告告警 | 1 | |
| silenceTime | Integer | 静默时间，单位：秒 | 300 | |
| recoverNotify | Integer | 恢复是否通知：0否，1是 | 0 | |
| notifyType | Array of String | 告警接收策略 | ["email", "sms"] | |
| contactGroupList | Array of String | 告警联系人组 | ["test"] | |
| notifyWeekdays | Array of Integer | 通知周期 | [0,1,2,3] | |
| notifyStart | String | 通知起始时段 | 00:00:00 | |
| notifyEnd | String | 通知结束时段 | 23:59:59 | |
| for | Integer | 持续时间，当规则执行结果持续多久符合条件时报警（防抖） | 120 | |
| metric | String | 监控指标 | cpu_util | |
| operator | String | 比较符：eq等于，gt大于，ge大于等于，lt小于，le小于等于 | ge | |
| value | String | 告警阈值 | 1000 | |
| period | String | 算法统计周期 | 5m | |
| fun | String | 算法：last原始值，avg平均值，max最大值，min最小值 | last | |
| instanceID | String | 资源唯一值 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| instanceName | String | 资源名称 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| deviceUUID | String | 资源ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| status | Integer | 告警规则启用状态：0启用，1停用 | 0 |
请求示例
GET /v4/monitor/query-alarm-rules?regionID=81f7728662dd11ec810800155d307d5b&status=2&page=1&pageSize=1
响应示例
{
"statusCode": 800,
"returnObj": {
"alarmRules": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "1c9109e9-d0a7-5905-9a73-86835e5802ed",
"triggerID": "634d170039fa5e04c4a33614",
"name": "告警规则示例",
"desc": "test",
"repeatTimes": 0,
"service": "ecs",
"dimension": "ecs",
"level": 1,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": [],
"contactGroupList": [],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:00:00",
"for": 120, "metric":
"mem_util",
"operator": "ge",
"value": "0",
"period": "5m",
"fun": "avg",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"status":1
}
],
"totalCount": 2,
"page": 1,
"pageSize": 1
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
