告警規則:修改告警規則條件
更新時間 2023-07-19 11:40:59
最近更新時間: 2023-07-19 11:40:59
分享文章
接口功能介紹
調用此接口可修改指定告警規則的告警條件。
接口約束
告警規則存在。
URI
POST /v4/monitor/update-alarm-rule-conditions
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| alarmRuleID | String | 是 | 2c2472df-f633-5b4b-be45-9609fc9f8154 | 告警規則ID | |
| dimension | String | 是 | ecs | 本參數表示告警維度。取值范圍:ecs:云主機。disk:磁盤。pms:物理機。...詳見“告警規則:獲取告警服務維度關系”接口返回。 | |
| metric | String | 是 | cpu_util | 監控指標 | |
| fun | String | 是 | avg | 本參數表示告警采用算法。取值范圍:last:原始值算法。avg:平均值算法。max:最大值算法。min:最小值算法。根據以上范圍取值。 | |
| operator | String | 是 | eq | 本參數表示比較符。默認值le。取值范圍:eq:等于。gt:大于。ge:大于等于。lt:小于。le:小于等于。根據以上范圍取值。 | |
| value | String | 是 | 300 | 告警閾值,整數、小數或百分數格式字符串 | |
| period | String | 是 | 10m | 本參數表示算法統計周期。默認值5m。參數fun為last時不可傳。參數fun為avg、max、min均需填此參數。本參數格式為“數字+單位”。單位取值范圍:m:分鐘。h:小時。d:天。根據以上范圍取值。 | |
| deviceUUID | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 資源唯一值 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼,參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述,一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
請求示例
POST /v4/monitor/update-alarm-rule-conditions
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "2c2472df-f633-5b4b-be45-9609fc9f8154",
"metric": "cpu_util",
"fun": "avg",
"operator": "ge",
"value": "300",
"period": "10m",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"dimension": "ecs"
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.AlarmRule.AlarmRuleNotFoundError | 告警規則不存在錯誤 |
| 其他 | 參見公共錯誤碼說明 |