告警联系人：批量删除
更新时间 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 | 部分告警联系人不存在 |
| 其他 | 参见公共错误码说明 |
