告警聯系人組：查詢列表v4.1
更新時間 2024-09-25 16:20:58
最近更新時間: 2024-09-25 16:20:58
分享文章
告警聯系人/組
告警聯系人組：查詢列表
接口功能介紹
調用此接口可查詢告警聯系人組的列表。
接口約束
無。
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 | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
