告警聯系人：查詢列表
更新(xin)時間 2023-07-19 19:00:27
最近更新時間(jian): 2023-07-19 19:00:27
分享(xiang)文(wen)章
接口功能介紹
調(diao)用此(ci)接口可查詢(xun)告警聯系人(ren)的列表。
接口約束
無。
URI
GET /v4/monitor/query-contacts
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 | |
|---|---|---|---|---|---|---|
| groupID | String | 否 | cf21ea17-e31d-5f47-bf10-6c489a86f67d | 所在組ID | ||
| name | String | 否 | testname | 名稱 | ||
| String | 否 | email@test.com | 郵箱 | |||
| phone | String | 否 | 13212341234 | 手機號 | ||
| search | String | 否 | email@test.com | 模糊搜索，可搜索字段為：（姓名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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactList | Array of Objects | 告警聯系人列表 | contact | |
| totalCount | Integer | 總記錄數 | 20 | |
| page | Integer | 頁碼 | 1 | |
| pageSize | Integer | 每頁條數 | 10 | |
| currentCount | Integer | 當前頁記錄數 | 5 | |
| totalPage | Integer | 總頁數 | 3 |
表contact
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactID | String | 告警聯系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| name | String | 用戶名 | gxlupdate | |
| phone | String | 手機號 | 18919128910 | |
| String | 郵箱 | 864307365@qq.com | ||
| contactGroupList | Array of Objects | 所屬組信息 | contactGroup | |
| lastUpdate | String | 最近更新時間 | 2022-09-29T09:51:33Z |
表contactGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| contactGroupID | String | 聯系人組ID | b6fb5df3-gasd-5bde-989c-df0819c687d0 | |
| name | String | 聯系人組名稱 | testgroup |
請求示例
GET /v4/monitor/query-contacts?groupID=cf21ea17-e31d-5f47-bf10-6c489a86f67d
響應示例
{
"statusCode":800,
"returnObj":{
"contactList":[
{
"contactID":"09127907-bc2e-5727-ba4d-51fe07f0f279",
"lastUpdate":"2022-09-22T03:09:15Z",
"name":"liuyechao",
"phone":"18117517979",
"email":"lyc@chinatelecom.cn",
"contactGroupList":[
{
"contactGroupID":"cf21ea17-e31d-5f47-bf10-6c489a86f67d",
"name":"group3"
},
{
"contactGroupID":"7e6b4ac7-cf07-561d-b381-fea74c401f50",
"name":"group2"
},
{
"contactGroupID":"65f78d86-9c8a-5e7f-8cee-b66a96fbf973",
"name":"group5"
}
]
},
{
"contactID":"e7598412-9dd0-5254-b8d2-79f405960596",
"lastUpdate":"2022-09-22T02:49:59Z",
"name":"liuyechao1",
"phone":"18117517979",
"email":"lyc@chinatelecom.cn",
"contactGroupList":[
]
},
...,
],
"totalCount":30,
"page":1,
"pageSize":10,
"currentCount":10,
"totalPage":3
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
