告警聯系人組：變更聯系人列表
更新時間(jian) 2023-07-19 11:40:56
最近更新時間: 2023-07-19 11:40:56
分享(xiang)文章
接口功能介紹
調(diao)用此接口(kou)可變(bian)更(geng)告警(jing)聯系(xi)(xi)組(zu)內的告警(jing)聯系(xi)(xi)人列表。
接口約束
告(gao)警聯系人(ren)組(zu)及告(gao)警聯系人(ren)存在。
URI
POST /v4/monitor/update-group-contacts
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| contactGroupID | String | 是 | fe7f0cdc-4692-5516-8d3a-b06355482090 | 組ID | |
| actionType | String | 是 | add | 本參數表示變更類型。取值范圍：add：新增。del：刪除。根據以上范圍取值。 | |
| contactIDList | Array of String | 否 | ["a6fb570f-2299-5bde-989c-df0819c687d0"] | 告警聯系人ID列表 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactGroupID | String | 告警聯系人組ID | bbfb781d-2299-5bde-989c-df0819c687d0 |
請求示例
POST /v4/monitor/update-group-contacts
請求體body
{
"contactGroupID": "fe7f0cdc-4692-5516-8d3a-b06355482090",
"actionType":"add",
"contactIDList":["6412da6e-7870-51c0-ac93-b8e5635be437"]
}
響應示例
{
"statusCode":800,
"returnObj":{
"contactGroupID":"fe7f0cdc-4692-5516-8d3a-b06355482090"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.ContactGroup.ContactGroupNotExist | 告警聯系組不存在 |
| 其他 | 參見公共錯誤碼說明 |
