告警联系人/组
告警联系人组:创建
接口功能介绍
调用此接口可创建告警联系组。
接口约束
告警联系人组名称不可重复,可包含字母、中文、数字,2-50个字符。
URI
POST /v4/monitor/create-contact-group
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 告警联系人组名称 | moCEN | |
desc | 否 | String | 组描述 | test | |
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/create-contact-group
请求头header
无
请求体body
{
"name": "hEtmm",
"contactIDList": [
"6412da6e-7870-51c0-ac93-b8e5635be437"
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"contactGroupID": "fe7f0cdc-4692-5516-8d3a-b06355482090"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.ContactGroup.NameAlreadyExist | 告警联系组名称已存在 |
Monitor.Contact.ContactsNotExist | 部分告警联系人不存在 |
其他 | 参见公共错误码说明 |