更新黑白名单防护规则
功能介绍
更新黑白名单防护规则,可以更新ip/ip段以及防护动作等信息
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
policy_id |
是 |
String |
防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id |
rule_id |
是 |
String |
黑白名单规则id,您可以调用查询黑白名单规则列表(ListWhiteblackipRule)获取黑白名单规则id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 缺省值:application/json;charset=utf8 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
黑白名单规则名称 |
addr |
否 |
String |
黑白名单ip地址,需要输入标准的ip地址或地址段,例如:42.123.120.66或42.123.120.0/16 |
description |
否 |
String |
黑白名单规则描述 |
white |
是 |
Integer |
防护动作:
|
ip_group_id |
否 |
String |
创建的Ip地址组id,该参数与addr参数使用一个即可;Ip地址组可在控制台中对象管理->地址组管理中添加。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
规则id |
name |
String |
黑白名单规则名称 |
policyid |
String |
策略id |
addr |
String |
黑白名单Ip/IP段 |
description |
String |
黑白名单规则描述 |
white |
Integer |
防护动作:
|
ip_group |
Ip_group object |
Ip地址组 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
Ip地址组id,在新增Ip地址组时系统自动生成的唯一标识 |
name |
String |
Ip地址组名 |
size |
Long |
Ip地址组中包含Ip/Ip段的数量 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0 { "name" : "demo", "white" : 0, "description" : "demo", "addr" : "1.1.1.2" }
响应示例
状态码: 200
请求成功
{ "id" : "5d43af25404341058d5ab17b7ba78b56", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "timestamp" : 1650531872900, "description" : "demo", "status" : 1, "addr" : "1.1.1.2", "white" : 0 }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。