接口功能介绍
调用此接口可修改告警联系组。
接口约束
告警联系人组存在,告警联系人组名称不可重复,可包含字母、中文、数字,2-30个字符。
URI
POST /v4/monitor/update-contact-group
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
contactGroupID | String | 是 | fe7f0cdc-4692-5516-8d3a-b06355482090 | 组ID | |
name | String | 否 | moCEN | 告警联系组新名称 | |
desc | String | 否 | test | 告警联系组新描述 | |
contactIDList | Array of String | 否 | ["a6fb570f-2299-5bde-989c-df0819c687d0"] | 告警联系人ID列表 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
contactGroupID | String | 告警联系人组ID | bbfb781d-2299-5bde-989c-df0819c687d0 |
请求示例
POST /v4/monitor/update-contact-group
请求体body
{
"contactGroupID": "fe7f0cdc-4692-5516-8d3a-b06355482090",
"name": "testname"
}
响应示例
{
"statusCode":800,
"returnObj":{
"contactID":"fe7f0cdc-4692-5516-8d3a-b06355482090"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.ContactGroup.ContactGroupNotExist | 告警联系组不存在 |
Monitor.ContactGroup.NameAlreadyExist | 告警联系组名称已存在 |
其他 | 参见公共错误码说明 |