创建全局白名单(原误报屏蔽)规则
功能介绍
创建全局白名单(原误报屏蔽)规则
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/waf/policy/{policy_id}/ignore
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID |
policy_id |
是 |
String |
防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略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 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
是 |
Array of strings |
防护域名或防护网站,数组长度为0时,代表规则对全部域名或防护网站生效 |
conditions |
是 |
Array of CreateCondition objects |
条件列表 |
mode |
是 |
Integer |
固定值为1,代表v2版本误报屏蔽规则,v1版本仅用于兼容旧版本,不支持创建 |
rule |
是 |
String |
需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔
|
advanced |
否 |
Array of Advanced objects |
高级配置项 |
description |
否 |
String |
屏蔽规则描述 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
是 |
String |
字段类型,可选值有ip、url、params、cookie、header |
contents |
是 |
Array of strings |
内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params,cookie,header时,内容的格式不做限制 |
logic_operation |
是 |
String |
匹配逻辑,匹配逻辑根据字段类型变化,字段类型为ip时,匹配逻辑支持(equal:等于,not_equal:不等于),字段类型为url、header、params、cookie时,匹配逻辑支持(equal:等于,not_equal:不等于,contain:包含,not_contain:不包含,prefix:前缀为,not_prefix:前缀不为,suffix:后缀为,not_suffix:后缀不为) |
check_all_indexes_logic |
否 |
Integer |
该参数为预留参数,可忽略。 |
index |
否 |
String |
字段类型为ip且子字段为客户端ip时,不需要传index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for;字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
规则id |
policyid |
String |
策略id |
timestamp |
Long |
创建规则的时间戳 |
description |
String |
规则描述 |
status |
Integer |
规则状态,0:关闭,1:开启 |
rule |
String |
需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔
|
mode |
Integer |
版本号固定值为1,代表v2版本误报屏蔽规则,v1版本仅支持兼容旧版本,不支持创建 |
conditions |
Array of Condition objects |
条件列表 |
advanced |
Array of Advanced objects |
高级配置项 |
domain |
Array of strings |
防护域名或防护网站 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
字段类型,可选值有ip、url、params、cookie、header |
contents |
Array of strings |
内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params、cookie、header时,内容的格式不做限制 |
logic_operation |
String |
匹配逻辑,匹配逻辑根据字段类型变化,字段类型为ip时,匹配逻辑支持(equal:等于,not_equal:不等于),字段类型为url、header、params、cookie时,匹配逻辑支持(equal:等于,not_equal:不等于,contain:包含,not_contain:不包含,prefix:前缀为,not_prefix:前缀不为,suffix:后缀为,not_suffix:后缀不为) |
check_all_indexes_logic |
Integer |
该参数为预留参数,可忽略。 |
index |
String |
字段类型为ip且子字段为客户端ip时,不存在index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for,字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段 |
参数 |
参数类型 |
描述 |
---|---|---|
index |
String |
字段类型,支持的字段类型有:Params、Cookie、Header、Body、Multipart。
|
contensts |
Array of strings |
指定字段类型的子字段,默认值为“全部” |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0 { "domain" : [ "we.test.418lab.cn" ], "conditions" : [ { "category" : "url", "logic_operation" : "contain", "contents" : [ "x.x.x.x" ], "index" : null } ], "mode" : 1, "description" : "demo", "rule" : "091004" }
响应示例
状态码: 200
OK
{ "id" : "a57f20ced01e4e0d8bea8e7c49eea254", "policyid" : "f385eceedf7c4c34a4d1def19eafbe85", "timestamp" : 1650522310447, "description" : "demo", "status" : 1, "rule" : "091004", "mode" : 1, "conditions" : [ { "category" : "url", "contents" : [ "x.x.x.x" ], "logic_operation" : "contain" } ], "domain" : [ "we.test.418lab.cn" ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。