查詢防護規則
更新時間 2024-12-05 17:31:11
最近更新時間: 2024-12-05 17:31:11
分享文章
接口功能介紹
防護規則查詢接口
接口約束
傳參規范
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
}
}
狀態碼
請參考
錯誤碼
請參考
