告警联系人/组
告警联系人：查看详情
接口功能介绍
调用此接口可查看告警联系人的配置详情。
接口约束
告警联系人ID存在。
URI
GET /v4/monitor/describe-contact
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| contactID | 是 | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | |
| name | String | 用户名 | gxlupdate | |
| phone | String | 手机号 | 18919128910 | |
| String | 邮箱 | 864307365@qq.com | ||
| phoneActivation | Integer | 本参数表示手机号码是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 | 0 | |
| emailActivation | Integer | 本参数表示邮箱是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 | 0 | |
| contactGroupList | Array of Objects | 所属组信息 | contactGroup | |
| updateTime | Integer | 最近更新时间, 时间戳，精确到毫秒 | 1667459789000 | |
| createTime | Integer | 创建时间，时间戳，精确到毫秒 | 1667459789000 |
表 contactGroup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactGroupID | String | 联系人组ID | b6fb5df3-gasd-5bde-989c-df0819c687d0 | |
| name | String | 联系人组名称 | testgroup |
请求示例
请求url
/v4/monitor/describe-contact?contactID=a6fb570f-2299-5bde-989c-df0819c687d0
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"returnObj":{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0",
"name":"gxlupdate",
"phone":"18919128910",
"email":"864307365@qq.com",
"phoneActivation":0,
"emailActivation":0,
"contactGroupList":[
],
"updateTime":1690370795000,
"createTime":1690370795000
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Contact.ContactNotExist | 告警联系人不存在 |
| 其他 | 参见公共错误码说明 |
