自定義告警規則：停用&啟用
更新時間 2024-09-25 16:20:52
最近更新時間: 2024-09-25 16:20:52
分享文章
告警規則
告警規則：停用&啟用
接口功能介紹
調用此接口可批量停用/啟用多個自定義監控/事件告警規則。
接口約束
告警規則存在。
URI
POST /v4/monitor/change-custom-alarm-rules-status
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleIDList | 是 | Array of Strings | 告警規則ID列表 | ['f79fe6a8-284f-5cd8-9031-812b06821b9c','eec4a76a-35ba-57b8-91c6-c4fd923351d6'] | |
| status | 是 | Integer | 本參數表示規則狀態。取值范圍：0：啟用。1：停用。根據以上范圍取值。 | 1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
請求示例
請求url
/v4/monitor/change-custom-alarm-rules-status
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleIDList": ["f79fe6a8-284f-5cd8-9031-812b06821b9c","eec4a76a-35ba-57b8-91c6-c4fd923351d6"],
"status": 0
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功 |
錯誤碼
| 錯誤碼 | 描述 |
|---|---|
| Monitor.CustomAlarmRule.RuleNotFound | 告警規則不存在 |
| 其他 | 參見公共錯誤碼說明 |
