接口功能介绍
查询黑白名单接口
接口约束
传参规范
URI
GET /vfw/v2_black_white_policy_query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| addressDirection | 否 | String | 地址方向 | dst | |
| blackWhiteType | 是 | String | 黑白类型 | BLACK | |
| firewallId | 是 | String | 防火墙id | dca4f9ffaca2447aa24310c1e62c4690 | |
| ip | 否 | String | ip地址 | 127.0.0.1/20 | |
| ipProto | 否 | String | ip协议 | v4 | |
| page | 否 | Integer | 页码 | 1 | |
| ruleId | 否 | Long | 规则id | 1099 | |
| ruleIds | 否 | String | 规则ids | [1099] | |
| ruleName | 否 | String | 规则名称 | 1099 | |
| size | 否 | Integer | 条数 | 10 | |
| addressGroup | 否 | String | 地址簿名称 | dst |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | PageInfo |
表 PageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数 | 1 | |
| list | Array of Objects | 结果集 | BlackWhitePolicyEntity | |
| 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 |
表 BlackWhitePolicyEntity
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleId | Long | 规则id | 1099 | |
| ruleName | String | 规则名称 | 1099 | |
| ipProto | String | ip协议 | v4 | |
| blackWhiteType | String | 黑白类型 | BLACK | |
| addressDirection | String | 地址方向 | dst | |
| ip | String | ip地址 | 127.0.0.1/20 | |
| mask | Integer | 掩码 | 32 | |
| blackWhiteDesc | String | 黑白名单描述 | ||
| status | Integer | 规则开关 | 10 | |
| ipBeginNum | String | ip的开始数字形式 | 127.0.0.1/20 | |
| ipEndNum | String | ip的结束数字形式 | 127.0.0.1/20 | |
| privateIps | String | 私网ips | 192.168.1.1/24 | |
| ipGroupId | Integer | ip地址组 | 11 | |
| ipGroupName | String | ip地址组 | 562b89493b1a40e1b97ea05e50dd8170 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 1,
"list": [
{
"ruleId": 17071,
"ruleName": "8.8.8.8",
"ipProto": "v4",
"blackWhiteType": "white",
"addressDirection": "dst",
"ip": "8.8.8.8",
"mask": 32,
"blackWhiteDesc": "",
"status": "enable",
"ipBeginNum": 134744072,
"ipEndNum": 134744072,
"privateIps": [
"8.8.8.8/32"
]
}
],
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 1,
"endRow": 1,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
状态码
请参考 状态码
错误码
请参考 错误码
