接口功能介绍
防护规则查询接口
接口约束
传参规范
URI
GET /vfw/v2_system_sec_policy_query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| action | 否 | String | 动作；drop；pass； | ||
| direction | 否 | String | 方向；in；out； | ||
| dstIp | 否 | String | 目的IP | ||
| dstIp6 | 否 | String | 目的IP6 | ||
| firewallId | 是 | String | 防火墙ID | ||
| ipProto | 否 | String | IP协议；v4；v6； | ||
| page | 否 | Integer | 页号 | 1 | |
| ruleIds | 否 | String | 规则ID | ||
| ruleName | 否 | String | 规则名称 | ||
| service | 否 | String | 服务类型；any；icmp；tcp；udp； | ||
| size | 否 | Integer | 当前页的数量 | 10 | |
| srcIp | 否 | String | 源IP | ||
| srcIp6 | 否 | String | 源IP6 | ||
| status | 否 | String | 规则开关；disable；enable； | ||
| addressGroup | 否 | String | 地址簿名称 |
请求参数
请求头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 | 结果集 | QuerySecpolicyRule | |
| 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 | String | 所有导航页号 | [1] | |
| navigateFirstPage | Integer | 导航条上的第一页 | 1 | |
| navigateLastPage | String | 导航条上的最后一页 | 1 |
表 QuerySecpolicyRule
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleName | String | 规则名称 | test | |
| firewallId | String | 防火墙id | dca4f9ffaca2447aa24310c1e62c4690 | |
| ipProto | String | IP协议，可能值 v4,v6。 | v4 | |
| direction | String | 方向，可能值 in,out。 | in | |
| action | String | 动作，可能值 drop,pass。 | pass | |
| dstIp | String | 目的IP V4必输 | 1.1.1.0 | |
| dstIpMask | Integer | 目的IP子网掩码 V4必输 | 24 | |
| dstIp6 | String | 目的IP6 V6必输 | 1:: | |
| dstIp6Mask | Integer | 目的IP6子网掩码 V6必输 | 96 | |
| srcIp | String | 源IP V4必输 | 2.2.2.0 | |
| srcIpMask | Integer | 源IP子网掩码 V4必输 | 24 | |
| srcIp6 | String | 源IP6 V6必输 | 2:: | |
| srcIp6Mask | Integer | 源IP6子网掩码 V6必输 | 96 | |
| service | String | 服务类型，可能值 any,icmp,tcp,udp。 | tcp | |
| dstPort | String | 目的端口 | 8080 | |
| srcPort | String | 源端口 | 8182 | |
| icmpType | String | icmpType | ||
| icmpCode | String | icmpCode | ||
| app | String | 应用ID 多个ID用逗号隔开 | 20,30 | |
| status | String | 规则开关，可能值 disable,enable。 | disable | |
| statistics | String | 统计开关，可能值 disable,enable。 | disable | |
| policy | Integer | 优先级 | 1 | |
| policyDesc | String | 防护规则描述 | 防护规则描述 | |
| quota | Integer | 占用规格数量 | 1 | |
| pos | String | 移动策略ID到最前或最后，可能值 head,remove,tail。 | head | |
| privateV4Ips | Array of Strings | V4私网ips | ||
| privateV6Ips | Array of Strings | V6私网ips | ||
| ipv4DstBeginNum | Long | 目的ipv4的开始数字形式 | ||
| ipv4DstEndNum | Long | 目的ipv4的结束数字形式 | ||
| ipv4SrcBeginNum | Long | 源ipv4的开始数字形式 | ||
| ipv4SrcEndNum | Long | 源ipv4的结束数字形式 | ||
| ipv6DstBeginNum | Long | 目的ipv6的开始数字形式 | ||
| ipv6DstEndNum | Long | 目的ipv6的结束数字形式 | ||
| ipv6SrcBeginNum | Long | 源ipv6的开始数字形式 | ||
| ipv6SrcEndNum | Long | 源ipv6的结束数字形式 | ||
| srcIpGroupId | Integer | 源地址组id | ||
| dstIpGroupId | Integer | 目的地址组id | ||
| srcPortGroupId | Integer | 源端口组id | ||
| dstPortGroupId | Integer | 目的端口组id | ||
| srcIpGroupName | String | 源地址组名称 | ||
| dstIpGroupName | String | 目的地址组名称 | ||
| srcPortGroupName | String | 源端口组名称 | ||
| dstPortGroupName | String | 目的端口组名称 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
无
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 1,
"list": [
{
"createTime": 1729837730,
"updateTime": 1729837730,
"ruleId": "17053",
"ruleName": "123",
"uid": "6069fd7ea3b943a287fea8de5ade38ab",
"regionId": "b342b77ef26b11ecb0ac0242ac110002",
"firewallId": "91e76b89efea420595fd859baf4eb2e4",
"ipProto": "v4",
"direction": "out",
"action": "drop",
"service": "tcp",
"dstPort": "1",
"srcPort": "1",
"app": "",
"status": "disable",
"statistics": "disable",
"priority": 1,
"appName": "ANY",
"appDescription": [
{
"appName": "ANY",
"description": ""
}
],
"policyDesc": "",
"quota": 1,
"ipv4DstBeginNum": 0,
"ipv4DstEndNum": 0,
"ipv4SrcBeginNum": 0,
"ipv4SrcEndNum": 0,
"ipv6DstBeginNum": 0,
"ipv6DstEndNum": 0,
"ipv6SrcBeginNum": 0,
"ipv6SrcEndNum": 0,
"srcIpGroupId": 9,
"dstIpGroupId": 1,
"srcIpGroupName": "test",
"dstIpGroupName": "test-chc-001"
}
],
"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
}
}
状态码
请参考 状态码
错误码
请参考 错误码
