更新时间:2022-10-09 GMT+08:00

查询防护策略列表

功能介绍

查询防护策略列表

URI

GET /v1/{project_id}/waf/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户的project_id

表2 Query参数

参数

是否必选

参数类型

描述

page

Integer

分页查询时,返回第几页数据。范围0-100000,默认值为1,表示返回第1页数据。

pagesize

Integer

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

name

String

策略名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

内容类型

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

防护策略的数量

items

Array of PolicyResponse objects

防护策略的具体内容

表5 PolicyResponse

参数

参数类型

描述

id

String

防护策略id

name

String

防护策略名

action

PolicyAction object

操作

options

PolicyOption object

选项

level

Integer

防护等级

full_detection

Boolean

精准防护中的检测模式

bind_host

Array of BindHost objects

防护域名的信息

timestamp

Long

创建防护策略的时间

extend

Map<String,String>

扩展字段

表6 PolicyAction

参数

参数类型

描述

category

String

防护等级(log为仅记录、block为拦截)

表7 PolicyOption

参数

参数类型

描述

webattack

Boolean

基础防护是否开启

common

Boolean

常规检测是否开启

crawler

Boolean

反爬虫是否开启

crawler_engine

Boolean

搜索engine是否开启

crawler_scanner

Boolean

反爬虫检测是否开启

crawler_script

Boolean

脚本反爬虫是否开启

crawler_other

Boolean

其他爬虫是否开启

webshell

Boolean

Webshell检测是否开启

cc

Boolean

cc规则是否开启

custom

Boolean

精准防护是否开启

whiteblackip

Boolean

黑白名单防护是否开启

geoip

Boolean

地理位置访问控制规则是否开启

ignore

Boolean

误报屏蔽是否开启

privacy

Boolean

隐私屏蔽是否开启

antitamper

Boolean

网页防篡改规则是否开启

antileakage

Boolean

防敏感信息泄露规则是否开启

bot_enable

Boolean

防网络机器人攻击是否开启

表8 BindHost

参数

参数类型

描述

id

String

域名ID

hostname

String

域名

waf_type

String

域名对应模式:cloud(云模式)/premium(独享模式)

mode

String

仅独享模式涉及特殊域名模式

状态码: 400

表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

错误信息

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码