文档首页/ Web应用防火墙 WAF/ API参考（安卡拉区域）/ API/ 策略规则管理/ 查询全局白名单(原误报屏蔽)规则列表
更新时间：2024-04-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询全局白名单(原误报屏蔽)规则列表

功能介绍

查询全局白名单(原误报屏蔽)规则列表

URI

GET /v1/{project_id}/waf/policy/{policy_id}/ignore

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

policy_id

是

String

防护策略id，通过指定防护策略id来指明查询该防护策略下的全局白名单规则，您可以通过调用查询防护策略列表（ListPolicy）获取策略id
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

page

否

Integer

分页查询时，返回第几页数据。默认值为1，表示返回第1页数据。

缺省值：1

pagesize

否

Integer

分页查询时，每页包含多少条结果。范围1-100，默认值为10，表示每页包含10条结果。

缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

该策略下全局白名单规则数量

items

Array of IgnoreRuleBody objects

全局白名单规则信息数组
表5 IgnoreRuleBody

参数

参数类型

描述

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

匹配逻辑支持（equal：等于，not_equal：不等于，contain：包含，not_contain：不包含，prefix：前缀为，not_prefix：前缀不为，suffix：后缀为，not_suffix：后缀不为）

conditions

Array of Condition objects

条件列表

domain

Array of strings

防护域名或防护网站

advanced

Advanced object

高级配置项
表6 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的值为自定义子字段
表7 Advanced

参数

参数类型

描述

index

String

字段类型，支持的字段类型有：params、cookie、header、body、multipart。

  • 当选择“params”、“cookie”或者“header”字段时，可以配置“全部”或根据需求配置子字段

  • 当选择“body”或“multipart”字段时，可以配置“全部”

contensts

Array of strings

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

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0&page=1&pagesize=10

响应示例

状态码： 200

OK

{
  "total" : 1,
  "items" : [ {
    "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

OK

400

请求失败

403

资源配额不足

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 策略规则管理