告警联系人/组
告警联系人组:删除
接口功能介绍
调用此接口可批量删除多个删除告警联系人组。
接口约束
告警联系人存在。
URI
POST /v4/monitor/delete-contact-groups
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
contactGroupIDList | 是 | Array of Strings | 告警联系人组ID列表 | ['dab749c9-f6b7-504f-ac99-f5a18be1de61'] |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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-contact-groups
请求头header
无
请求体body
{
"contactGroupIDList": [
"dab749c9-f6b7-504f-ac99-f5a18be1de61",
"fe7f0cdc-4692-5516-8d3a-b06355482090"
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.ContactGroup.ContactGroupsNotExist | 部分告警联系组不存在 |
其他 | 参见公共错误码说明 |