接口功能介绍
查询地址簿列表
接口约束
传参规范
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"
}
状态码
请参考 状态码
错误码
请参考 错误码
