告警联系人/组
告警联系人：修改
接口功能介绍
调用此接口可修改告警联系人配置，支持全量字段修改。
接口约束
告警联系人ID存在，告警联系人名称不可重复，可包含字母、中文、数字，2-50个字符。
URI
POST /v4/monitor/update-contacts
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| contactID | 是 | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| name | 是 | String | 用户名 | moCEN | |
| phone | 否 | String | 手机号，手机号和邮箱二选一必填，手机号填了，邮箱可不填，反之一样，二者不能全为空。 | 13309310049 | |
| 否 | String | 邮箱， 手机号和邮箱二选一必填，邮箱填了，手机号可不填，反之一样，二者不能全为空。 | 123323@qq.com |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactID | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 |
请求示例
请求url
/v4/monitor/update-contacts
请求头header
无
请求体body
{
"contactID": "a6fb570f-2299-5bde-989c-df0819c687d0",
"name": "gxlupdate",
"phone":"18919128910",
"email":"864307365@qq.com"
}
响应示例
{
"statusCode":800,
"returnObj":{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Contact.ContactNotExist | 告警联系人不存在 |
| Monitor.Contact.NameAlreadyExist | 告警联系人名称已存在 |
| 其他 | 参见公共错误码说明 |
