文档首页> Web应用防火墙 WAF> API参考> API> 策略规则管理> 删除全局白名单(原误报屏蔽)防护规则
更新时间:2022-10-09 GMT+08:00
分享

删除全局白名单(原误报屏蔽)防护规则

功能介绍

删除全局白名单(原误报屏蔽)防护规则

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

DELETE /v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID

policy_id

String

防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id

rule_id

String

误报屏蔽规则id,您可以通过查询误报屏蔽规则列表(ListIgnoreRule)接口的响应体中的id字段获取误报屏蔽规则id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

规则id

policyid

String

策略id

timestamp

Long

创建规则的时间戳

description

String

规则描述

status

Integer

规则状态,0:关闭,1:开启

url

String

误报规则屏蔽路径,仅在mode为0的状态下有该字段

rule

String

需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔

  • 当需要屏蔽某一条内置规则时,该参数值为该内置规则id,可以在Web应用防火墙控制台的防护策略->策略名称->Web基础防护的高级设置->防护规则中查询;也可以在防护事件的事件详情中查询内置规则id

  • 当需要屏蔽web基础防护某一类规则时,该参数值为需要屏蔽的web基础防护某一类规则名。其中,xss:xxs攻击;webshell:网站木马;vuln:其他类型攻击;sqli:sql注入攻击;robot:恶意爬虫;rfi:远程文件包含;lfi:本地文件包含;cmdi:命令注入攻击

  • 当需要屏蔽Web基础防护模块,该参数值为:all

  • 当需要屏蔽规则为所有检测模块时,该参数值为:bypass

mode

Integer

版本号,0代表v1旧版本,1代表v2新版本;mode为0时,不存在conditions字段,存在url和url_logic字段;mode为1时,不存在url和url_logic字段,存在conditions字段

url_logic

String

url匹配逻辑

conditions

Array of Condition objects

条件

advanced

Array of Advanced objects

高级配置项

domains

Array of strings

防护域名或防护网站

表5 Condition

参数

参数类型

描述

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的值为自定义子字段

表6 Advanced

参数

参数类型

描述

index

String

字段类型,支持的字段类型有:Params、Cookie、Header、Body、Multipart。

  • 当选择“Params”、“Cookie”或者“Header”字段时,可以配置“全部”或根据需求配置子字段

  • 当选择“Body”或“Multipart”字段时,可以配置“全部”

contensts

Array of strings

指定字段类型的子字段,默认值为“全部”

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}

响应示例

状态码: 200

请求成功

{
  "id" : "40484384970948d79fffe4e4ae1fc54d",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "timestamp" : 1650512535222,
  "description" : "demo",
  "status" : 1,
  "rule" : "091004",
  "mode" : 1,
  "conditions" : [ {
    "category" : "ip",
    "contents" : [ "x.x.x.x" ],
    "logic_operation" : "equal"
  } ],
  "domain" : [ "we.test.418lab.cn" ]
}

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品