接口功能介绍
新增黑白名单接口
接口约束
传参规范
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"
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
