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