告警聯系人：批量刪除
更新時間 2024-09-25 16:20:57
最近更新時間: 2024-09-25 16:20:57
分享文章
告警聯系人/組
告警聯系人：批量刪除
接口功能介紹
調用此接口可批量刪除多個創建告警聯系人。
接口約束
告警聯系人存在。
URI
POST /v4/monitor/delete-contacts
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| contactIDList | 是 | Array of Strings | 告警聯系人ID列表 | ['a6fb570f-2299-5bde-989c-df0819c687d0','b27dbeb4-1d5c-5e00-8b47-5930b60d7621'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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/delete-contacts
請求頭header
無
請求體body
{
"contactIDList": [
"248848b7-b1bb-598c-a195-084ccc7187ba",
"b27dbeb4-1d5c-5e00-8b47-5930b60d7621"
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Contact.ContactsNotExist | 部分告警聯系人不存在 |
| 其他 | 參見公共錯誤碼說明 |
