接口功能介绍
查询黑白名单详情接口
接口约束
传参规范
URI
GET /vfw/v2_black_white_policy_info
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| blackWhiteType | 是 | String | 黑白类型，black，white | ||
| firewallId | 是 | String | 防火墙id | ||
| regionId | 是 | String | 资源池id | ||
| ruleId | 是 | Long | 规则id | ||
| uid | 是 | String | 租户id |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| userId | 是 | String | 用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| accountId | 是 | String | 账号id | ca888cf3674d4a83a42dbd71f4a09e94 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | PageInfo |
表 PageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| addressDirection | String | 地址方向，dst，src | dst | |
| blackWhiteDesc | String | 黑白名单描述 | 黑白名单描述 | |
| blackWhiteType | String | 黑白类型，black，white | black | |
| firewallId | String | 防火墙ID | a6449feab4db11e9a6b40242ac110007 | |
| ip | String | 127.0.0.1 | ||
| ipBeginNum | String | ip的开始数字形式 | ||
| ipEndNum | String | ip的结束数字形式 | ||
| ipProto | String | IP协议，v4，v6 | v4 | |
| mask | Integer | 掩码 | 24 | |
| privateIps | String | 私网ips | 192.168.1.1/24 | |
| regionId | String | 资源池ID | a6449feab4db11e9a6b40242ac110007 | |
| ruleId | Long | 规则ID | 321 | |
| ruleName | String | 规则名称 | ||
| status | String | 规则开关，disable，enable | disable | |
| uid | String | 租户ID | 9f3618ee1c594598a942550985345d0d |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","userId":"562b89493b1a40e1b97ea05e50dd8170","accountId":"ca888cf3674d4a83a42dbd71f4a09e94","urlType": "CTAPI"}
请求体body
{}
响应示例
{"statusCode": "200","error": "CFW_0000","message": "成功!","returnObj": {"addressDirection": "dst","blackWhiteDesc": "黑白名单描述","blackWhiteType": "black","firewallId": "a6449feab4db11e9a6b40242ac110007","ip": "1.1.1.1","ipBeginNum": "","ipEndNum": "","ipProto": "v4","mask": 0,"privateIps": [],"regionId": "fecnjniakfkn2314ndekqldedcsadfg","ruleId": 321,"ruleName": "","status": "disable","uid": "562b89493b1a40e1b97ea05e50dd8170"},}
状态码
请参考 状态码
错误码
请参考 错误码
