告警規則：查看詳情
更新時間 2023-07-19 11:40:58
最近更新時間: 2023-07-19 11:40:58
分享文章
接口功能介紹
查看告警規則的詳情信息。
接口約束
regionID（資源池）和alarmRuleID（告警規則）存在。
URI
GET /v4/monitor/describe-alarm-rule
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun資源池ID | |
| alarmRuleID | String | 是 | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | 告警規則ID |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| alarmRule | Object | 告警規則 | alarmRule |
表alarmRule
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | ctyun資源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleID | String | 告警規則ID | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | |
| triggerID | String | 監控平臺的規則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。取值范圍：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/describe-alarm-rule?regionID=81f7728662dd11ec810800155d307d5b&alarmRuleID=3dbd23b2-74e2-53f8-869c-6fe6b07b9dba
響應示例
{
"statusCode": 800,
"returnObj": {
"alarmRule": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "3dbd23b2-74e2-53f8-869c-6fe6b07b9dba",
"triggerID": "634d170039fa5e04c4a33614",
"name": "告警規則lyc123",
"desc": "",
"repeatTimes": 0,
"service": "ecs",
"dimension": "ecs",
"level": 1,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": [],
"contactGroupList": [],
"notifyWeekdays": [0,1,2,3],
"notifyStart": "00:00:00",
"notifyEnd": "23:00:00",
"for": 120,
"metric": "cpu_util",
"operator": "ge",
"value": "1000",
"period": "5m",
"fun": "avg",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"status": 0
}
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
