接口功能介绍
调用此接口可变更告警联系人所属的告警联系人组列表。
接口约束
告警联系人及告警联系人组存在。
URI
POST /v4/monitor/update-contact-groups
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| contactID | String | 是 | a6fb570f-2299-5bde-989c-df0819c687d0 | 告警联系人ID | |
| actionType | String | 是 | add | 本参数表示变更类型。取值范围：add：新增。del：删除。根据以上范围取值。 | |
| contactGroupIDList | Array of String | 否 | ["fe7f0cdc-4692-5516-8d3a-b06355482090"] | 告警联系人组ID列表 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactID | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 |
请求示例
POST /v4/monitor/update-contact-groups
请求体body
{
"contactID": "6412da6e-7870-51c0-ac93-b8e5635be437",
"actionType":"add",
"contactGroupIDList":["fe7f0cdc-4692-5516-8d3a-b06355482090"]
}
响应示例
{
"statusCode":800,
"returnObj":{
"contactID":"6412da6e-7870-51c0-ac93-b8e5635be437"},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Contact.ContactNotExist | 告警联系人不存在 |
| 其他 | 参见公共错误码说明 |
