查詢地址簿
更新時間 2024-12-05 17:31:12
最近更新時間: 2024-12-05 17:31:12
分享文章
接口功能介紹
查詢地址簿列表
接口約束
傳參規范
URI
GET /vfw/v2_address_group_query
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| ip | 否 | String | 校驗合法 | 1.1.1.1 | |
| addressType | 否 | String | 地址簿類型v4;v6;port | v4 | |
| addressGroupName | 否 | String | 地址簿名稱 | name | |
| groupId | 否 | Long | 地址簿id | 1 | |
| page | 否 | Integer | 頁碼 | 1 | |
| size | 否 | Integer | 頁大小 | 10 |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 請求地址類型 | CTAPI | |
| regionId | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 |
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 | 800 | |
| message | String | 返回信息 | 成功 | |
| error | String | 錯誤碼：CFW_0000 :成功!;CFW_0001:參數錯誤！;CFW_0002：業務錯誤！ | CFW_0000 | |
| returnObj | Object | 接口返回結果 | PageInfo |
表 PageInfo
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Integer | 總記錄數 | 1 | |
| list | Array of Objects | 結果集 | AddressGroupQueryView | |
| pageNum | Integer | 當前頁的頁碼 | 1 | |
| pageSize | Integer | 每頁的數量 | 10 | |
| size | Integer | 當前頁的數量 | 1 | |
| startRow | Long | 當前頁面第一個元素在數據庫中的行號 | 1 | |
| endRow | Long | 當前頁面最后一個元素在數據庫中的行號 | 1 | |
| pages | Integer | 總頁數 | 1 | |
| prePage | Integer | 前一頁 | 0 | |
| nextPage | Integer | 下一頁 | 0 | |
| isFirstPage | Boolean | 是否為首頁 | true | |
| isLastPage | Boolean | 是否為末頁 | true | |
| hasPreviousPage | Boolean | 是否有前一頁 | false | |
| hasNextPage | Boolean | 是否有下一頁 | false | |
| navigatePages | Integer | 導航頁碼數 | 8 | |
| navigatepageNums | Array of Integers | 所有導航頁號 | [1] | |
| navigateFirstPage | Integer | 導航條上的第一頁 | 1 | |
| navigateLastPage | String | 導航條上的最后一頁 | 1 |
表 AddressGroupQueryView
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| groupId | Integer | 地址簿id | 1 | |
| addressGroupName | String | 地址簿名稱 | name | |
| description | String | 地址簿描述 | 描述 | |
| addressType | String | 地址簿類型v4;v6;port | v4 | |
| num | Integer | ip數量 | 2 | |
| isReferenced | Boolean | 是否被引用 | true |
枚舉參數
無
請求示例
請求url
無
請求頭header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
請求體body
{}
響應示例
{
"statusCode": "200",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 7,
"list": [
{
"groupId": 7,
"addressGroupName": "wxh-test",
"num": 1,
"description": "",
"addressType": "v4",
"isReferenced": false
}
],
"pageNum": 1,
"pageSize": 10,
"size": 7,
"startRow": 1,
"endRow": 7,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
},
"statusCode": "800"
}
狀態碼
請參考
錯誤碼
請參考
