告警联系人/组
告警联系人组：变更联系人列表
接口功能介绍
调用此接口可变更告警联系组内的告警联系人列表。
接口约束
告警联系人组及告警联系人存在。
URI
POST /v4/monitor/update-group-contacts
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| contactGroupID | 是 | String | 组ID | fe7f0cdc-4692-5516-8d3a-b06355482090 | |
| actionType | 是 | String | 本参数表示变更类型。取值范围：add：新增。del：删除。根据以上范围取值。 | add | |
| contactIDList | 是 | Array of Strings | 告警联系人ID列表 | ['a6fb570f-2299-5bde-989c-df0819c687d0'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactGroupID | String | 告警联系人组ID | bbfb781d-2299-5bde-989c-df0819c687d0 |
请求示例
请求url
/v4/monitor/update-group-contacts
请求头header
无
请求体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.Contact.ContactsNotExist | 部分告警联系人不存在 |
| Monitor.ContactGroup.ContactGroupNotExist | 告警联系组不存在 |
| 其他 | 参见公共错误码说明 |
