接口功能介绍
调用此接口可创建告警联系人，用于告警通知。
接口约束
告警联系人名称不可重复，可包含字母、中文、数字，2-30个字符。
URI
POST /v4/monitor/create-contact
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| name | String | 是 | moCEN | 用户名 | |
| phone | String | 否 | 13309310049 | 手机号 | |
| String | 否 | 123323@qq.com | 邮箱 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/create-contact
请求体body
{
"name": "moCEN",
"phone": "13309310049",
"email": "123323@qq.com"
}
响应示例
{
"statusCode":800,
"returnObj":{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Contact.NameAlreadyExist | 告警联系人名称已存在 |
| 其他 | 参见公共错误码说明 |
