文档首页/ Web应用防火墙 WAF/ API参考（阿布扎比区域）/ API/ 防护策略管理/ 根据Id查询防护策略
更新时间：2023-01-16 GMT+08:00
查看PDF
分享

根据Id查询防护策略

功能介绍

根据Id查询防护策略

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

policy_id

是

String

防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略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

name

String

防护策略名

level

Integer

Web基础防护等级

  • 1 : 宽松，防护粒度较粗，只拦截攻击特征比较明显的请求。当误报情况较多的场景下，建议选择“宽松”模式。

  • 2：中等，默认为“中等”防护模式，满足大多数场景下的Web防护需求。

  • 3：严格，防护粒度最精细，可以拦截具有复杂的绕过特征的攻击请求，例如jolokia网络攻击、探测CGI漏洞、探测 Druid SQL注入攻击

缺省值：2

枚举值：

  • 1

  • 2

  • 3

full_detection

Boolean

精准防护中的检测模式。

  • false：短路检测，当用户的请求符合精准防护中的拦截条件时，便立刻终止检测，进行拦截

  • true ：全检测，请求符合精准防护中的拦截条件时，全检测不会立即拦截，会继续执行其他防护的检测，最后进行拦截。

action

PolicyAction object

防护动作信息

options

PolicyOption object

该参数存放防护策略里防护项的开关信息

hosts

Array of strings

与防护策略绑定的防护的域名id数组

bind_host

Array of BindHost objects

与防护策略绑定的防护的域名信息数组，相对于hosts字段，包含更详细的域名信息

extend

Map<String,String>

扩展字段，用于存放Web基础防护中一些开关配置等信息

timestamp

Long

创建防护策略的时间
表5 PolicyAction

参数

参数类型

描述

category

String

web基础防护动作（log为仅记录、block为拦截）

枚举值：

  • block

  • log
表6 PolicyOption

参数

参数类型

描述

webattack

Boolean

基础防护是否开启

枚举值：

  • true

  • false

common

Boolean

常规检测是否开启

枚举值：

  • true

  • false

crawler

Boolean

预留参数，改参数值一直为true，用户可忽略该参数值

枚举值：

  • true

  • false

crawler_engine

Boolean

搜索engine是否开启

枚举值：

  • true

  • false

crawler_scanner

Boolean

反爬虫检测是否开启

枚举值：

  • true

  • false

crawler_script

Boolean

脚本反爬虫是否开启

枚举值：

  • true

  • false

crawler_other

Boolean

其他爬虫是否开启

枚举值：

  • true

  • false

webshell

Boolean

Webshell检测是否开启

枚举值：

  • true

  • false

cc

Boolean

cc规则是否开启

枚举值：

  • true

  • false

custom

Boolean

精准防护是否开启

枚举值：

  • true

  • false

whiteblackip

Boolean

黑白名单防护是否开启

枚举值：

  • true

  • false

geoip

Boolean

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

枚举值：

  • true

  • false

ignore

Boolean

误报屏蔽是否开启

枚举值：

  • true

  • false

privacy

Boolean

隐私屏蔽是否开启

枚举值：

  • true

  • false

antitamper

Boolean

网页防篡改规则是否开启

枚举值：

  • true

  • false

antileakage

Boolean

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

枚举值：

  • true

  • false

bot_enable

Boolean

网站反爬虫总开关是否开启

枚举值：

  • true

  • false

followed_action

Boolean

攻击惩罚规则是否开启

枚举值：

  • true

  • false
表7 BindHost

参数

参数类型

描述

id

String

域名ID

hostname

String

域名

waf_type

String

域名对应模式：cloud（云模式）/premium（独享模式）

mode

String

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

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}?enterprise_project_id=0

响应示例

状态码： 200

OK

{
  "id" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "level" : 2,
  "action" : {
    "category" : "log"
  },
  "options" : {
    "webattack" : true,
    "common" : true,
    "crawler" : true,
    "crawler_engine" : false,
    "crawler_scanner" : true,
    "crawler_script" : false,
    "crawler_other" : false,
    "webshell" : false,
    "cc" : true,
    "custom" : true,
    "whiteblackip" : true,
    "geoip" : true,
    "ignore" : true,
    "privacy" : true,
    "antitamper" : true,
    "antileakage" : false,
    "bot_enable" : true
  },
  "hosts" : [ ],
  "extend" : { },
  "timestamp" : 1650529538732,
  "full_detection" : false,
  "bind_host" : [ ]
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 防护策略管理