接口功能介绍
调用此接口可查询告警联系人组的列表。
接口约束
无。
URI
GET /v4/monitor/query-contact-groups
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| name | String | 否 | testname | 组名 | |
| search | String | 否 | name123 | 模糊搜索，可搜索字段为联系人的：告警联系组组名（name）、告警联系人姓名（name）、告警联系人手机号（phone）、告警联系人邮箱（email） | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 10 | 每页大小 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactGroupList | Array of Objects | 告警联系人组列表 | contactGroup | |
| totalCount | Integer | 总记录数 | 20 | |
| page | Integer | 页码 | 1 | |
| pageSize | Integer | 每页条数 | 10 | |
| 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 | |
| lastUpdate | String | 最近更新时间 | 2022-09-29T09:51:33Z |
表contact
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactID | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| name | String | 用户名 | gxlupdate | |
| phone | String | 手机号 | 18919128910 | |
| String | 邮箱 | 864307365@qq.com | ||
| lastUpdate | String | 最近更新时间 | 2022-09-29T09:51:33Z |
请求示例
GET /v4/monitor/query-contact-groups?name=group3
响应示例
{
"statusCode":800,
"returnObj":{
"contactGroupList":[
{
"contactGroupID":"cf21ea17-e31d-5f47-bf10-6c489a86f67d",
"lastUpdate":"2022-09-22T03:09:15Z",
"name":"group3",
"desc":"test",
"contactList":[
{
"contactID":"09127907-bc2e-5727-ba4d-51fe07f0f279",
"lastUpdate":null,
"name":"liuyechao",
"phone":"18117517979",
"email":"lyc@chinatelecom.cn"
}
]
},
...,
],
"totalCount":10,
"page":1,
"pageSize":2,
"currentCount":2,
"totalPage":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
