告警規則:設置通知周期
更新時間 2023-07-19 11:40:58
最近更新時間: 2023-07-19 11:40:58
分享文章
接口功能介紹
調用此接口可設置指定告警規則的通知周期。
接口約束
告警規則存在。
URI
POST /v4/monitor/set-alarm-rule-notify-time
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| alarmRuleID | String | 是 | 2c2472df-f633-5b4b-be45-9609fc9f8154 | 告警規則ID | |
| notifyWeekdays | Array of Integer | 否 | [0,1,2,3,4,5,6] | 本參數表示通知周期。默認值[0,1,2,3,4,5,6]。取值范圍:0:周日。1:周一。2:周二。3:周三。4:周四。5:周五。6:周六。根據以上范圍取值。 | |
| notifyStart | String | 否 | 00:00:11 | 通知起始時段,默認值為全時段"00:00:00" | |
| notifyEnd | String | 否 | 23:59:59 | 通知結束時段,默認值為全時段"23:59:59" |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼,參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述,一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
請求示例
POST /v4/monitor/set-alarm-rule-notify-time
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "2c2472df-f633-5b4b-be45-9609fc9f8154",
"notifyWeekdays": [0,1,2,3],
"notifyStart": "00:00:11",
"notifyEnd": "23:59:00"
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.AlarmRule.AlarmRuleNotFoundError | 告警規則不存在錯誤 |
| 其他 | 參見公共錯誤碼說明 |