告警規則：查詢列表
更新時間 2023-07-19 11:40:58
最近更新時間: 2023-07-19 11:40:58
分享文章
接口功能介紹
根據篩選項查詢告警規則列表。
接口約束
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 | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
