新增黑白名單
更新時間 2024-12-05 17:31:12
最近更新時間: 2024-12-05 17:31:12
分享文章
接口功能介紹
新增黑白名單接口
接口約束
傳參規范
URI
POST /vfw/v2_black_white_policy_add
路徑參數
無
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 請求地址類型 | CTAPI | |
| regionId | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| addressDirection | 是 | String | 地址方向，dst:,src: | dst | |
| blackWhiteDesc | 否 | String | 黑白名單描述 | 黑白名單描述 | |
| blackWhiteType | 是 | String | 黑白類型，black:,white: | ||
| firewallId | 是 | String | 防火墻ID | a6449feab4db11e9a6b40242ac110007 | |
| ip | 否 | String | 127.0.0.1/32 | ||
| ipProto | 是 | String | IP協議，v4:,v6: | v4 | |
| mask | 否 | Integer | 32 | 24 | |
| ruleName | 是 | String | 規則名稱 | ||
| ipGroupId | 否 | Integer | ip地址組 | 11 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 錯誤碼：CFW_0000 :成功!;CFW_0001:參數錯誤！;CFW_0002：業務錯誤！ | CFW_0000 | |
| returnObj | Object | 接口返回結果 | BlackWhitePolicyEntity |
表 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
{
"addressDirection": "dst",
"blackWhiteDesc": "黑白名單描述",
"blackWhiteType": "",
"firewallId": "a6449feab4db11e9a6b40242ac110007",
"ip": "",
"ipProto": "v4",
"mask": 0,
"ruleName": ""
}
響應示例
{
"statusCode": "200",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"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"
]
}
}
狀態碼
請參考
錯誤碼
請參考
