告警联系人/组
告警联系人组：查询列表
接口功能介绍
调用此接口可查询告警联系人组的列表。
接口约束
无。
URI
POST /v4.1/monitor/query-contact-groups
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 组名 | testname | |
| search | 否 | String | 模糊搜索，可搜索字段为联系人的：告警联系组组名（name）、告警联系人姓名（name）、告警联系人手机号（phone）、告警联系人邮箱（email） | name123 | |
| pageNo | 否 | Integer | 页码，默认为1 | 1 | |
| pageSize | 否 | Integer | 每页大小 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactGroupList | Array of Objects | 告警联系人组列表 | contactGroup | |
| totalCount | Integer | 总记录数 | 20 | |
| currentCount | Integer | 当前页记录数 | 5 | |
| totalPage | Integer | 总页数 | 3 |
表 contactGroup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactGroupID | String | 告警联系人组ID | cf21ea17-e31d-5f47-bf10-6c489a86f67d | |
| name | String | 组名 | group3 | |
| desc | String | 组备注 | test | |
| contactList | Array of Objects | 告警联系人列表 | contact | |
| updateTime | Integer | 最近更新时间, 时间戳，精确到毫秒 | 1667459789000 | |
| createTime | Integer | 创建时间，时间戳，精确到毫秒 | 1667459789000 |
表 contact
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactID | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| name | String | 用户名 | gxlupdate | |
| phone | String | 手机号 | 18919128910 | |
| String | 邮箱 | 864307365@qq.com | ||
| updateTime | Integer | 最近更新时间, 时间戳，精确到毫秒 | 1667459789000 | |
| createTime | Integer | 创建时间，时间戳，精确到毫秒 | 1667459789000 | |
| phoneActivation | Integer | 本参数表示手机号码是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 | 0 | |
| emailActivation | Integer | 本参数表示邮箱是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 | 0 |
请求示例
请求url
/v4.1/monitor/query-contact-groups
请求头header
无
请求体body
{
"name":"testname",
"search":"test",
"pageNo":1,
"pageSize":10
}
响应示例
{
"statusCode":800,
"returnObj":{
"contactGroupList":[
{
"contactGroupID":"e334fd07-4038-5f4a-86bd-fdbeb664e06c",
"name":"的观点来看",
"desc":"test",
"contactList":[
{
"contactID":"f5e9216c-94fb-5237-a78a-c711c1239c99",
"updateTime":1689323237000,
"createTime":1689323237000,
"name":"leezm",
"phone":"17330625231",
"email":"aaa@qq.com",
"phoneActivation":0,
"emailActivation":0
}
],
"updateTime":1689323258000,
"createTime":1689323258000
}
],
"totalCount":10,
"currentCount":1,
"totalPage":10
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
