更新时间:2022-12-29 GMT+08:00

查询所有防护策略

功能介绍

查询防护策略列表。

URI

  • URI格式

    GET /v1/{project_id}/waf/policy?policyname={policyname}&offset={offset}&limit={limit}

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    用户操作的项目ID。

    policyname

    String

    策略名称。GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip?offset={offset}&limit={limit}

    offset

    Long

    指定返回的页数,取值范围为:[0, 65535],默认值为0。

    limit

    Long

    指定查询返回每页记录的最大条数,取值范围为:(0, 10],默认值为10。

请求消息

请求参数

响应消息

响应参数
表2 响应参数说明

名称

参数类型

说明

total

Integer

防护策略总数。

items

表3

防护策略对象列表。

表3 items

名称

参数类型

说明

id

String

实例ID。

name

String

防护策略名称。

options

表4

防护规则是否开启。

action

表5

Web基础防护中的防护动作。

  • “block”:拦截并且记录。
  • “log”:仅记录不拦截。

level

Integer

防护等级。

  • “1”:表示低。

    不检测header中的XSS攻击和CMDI攻击,当发现防护规则拦截了您的正常业务时,可调整防护等级为“1”“1”防护下对业务的误报率降低,但漏报率可能会增高,例如:wget、curl等检测。

  • “2”:表示中。

    默认情况下,选择“2”,根据文件的敏感程度区分,中危检测有远程文件包含、第三方软件漏洞、Webshell、cp、ftp。

  • “3”:表示高。

    当您需要更严格的防护等级时,建议选择“3”,而“3”防护下对业务的误报率可能会增高,但漏报率降低,例如nc、nmap、kill等。

full_detection

Boolean

精准防护中的检测模式。

  • true:全检测。当用户的请求符合精准防护中的拦截条件时,不会立即拦截,WAF会继续执行其他防护的检测,待其他防护的检测完成后进行拦截。
  • false:短路检测。当用户的请求符合精准防护中的拦截条件时,便立刻终止检测,进行拦截。

hosts

Array

防护域名的ID。

timestamp

Long

创建策略的时间。

表4 options

名称

参数类型

说明

webattack

Boolean

Web攻击是否开启。

  • true:表示开启。
  • false:表示关闭。

common

Boolean

Web攻击的常规攻击检测是否开启。

  • true:表示开启。
  • false:表示关闭。

crawler

Boolean

Web攻击的爬虫检测是否开启。

  • true:表示开启。
  • false:表示关闭。

crawler_engine

Boolean

Web攻击的搜索引擎是否开启。

  • true:表示开启。
  • false:表示关闭。

crawler_scanner

Boolean

Web攻击的扫描器是否开启。

  • true:表示开启。
  • false:表示关闭。

crawler_script

Boolean

Web攻击的脚本工具是否开启。

  • true:表示开启。
  • false:表示关闭。

crawler_other

Boolean

Web攻击的其他爬虫是否开启。

  • true:表示开启。
  • false:表示关闭。

webshell

Boolean

Web攻击的Webshell是否开启。

  • true:表示开启。
  • false:表示关闭。

cc

Boolean

Web攻击的CC防护是否开启。

  • true:表示开启。
  • false:表示关闭。

custom

Boolean

Web攻击的精准访问防护是否开启。

  • true:表示开启。
  • false:表示关闭。

whiteblackip

Boolean

Web攻击的IP黑白名单是否开启。

  • true:表示开启。
  • false:表示关闭。

privacy

Boolean

Web攻击的隐私屏蔽是否开启。

  • true:表示开启。
  • false:表示关闭。

Ignore

Boolean

Web攻击的误报屏蔽是否开启。

  • true:表示开启。
  • false:表示关闭。

antitamper

Boolean

Web攻击的网页防篡改是否开启。

  • true:表示开启。
  • false:表示关闭。
表5 action

名称

参数类型

说明

category

String

Web基础防护中防护动作的类型。

  • “block”:拦截。
  • “log”:仅记录不拦截。

示例

如下以查询所有防护策略,返回记录条数为“2”为例。

响应样例
{
    "total": 2,
    "items": [
        {
          "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
          "name": "policy_1",
          "action": {
              "category ": "block"
           },
           "options": {
               "webattack": true,
               "common": true,
               "crawler": true,
               "crawler_engine": true,
               "crawler_scanner": true,
               "crawler_script": true,
               "crawler_other": true,
               "webshell": true,
               "cc": true,
               "custom": true,
               "whiteblackip": true,
               "ignore": true,
               "privacy": true,
               "antitamper": true
            },
           "level": 1,
           "full_detection": false,
           "hosts": ["11111111111111111", "2222222222222222222"],
           "timestamp": 1499817612
        }, {
          "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
          "name": "policy_2",
          "action": {
              "category": "block"
           },
           "options": {
               "webattack": true,
               "common": true,
               "crawler": true,
               "crawler_engine": true,
               "crawler_scanner": true,
               "crawler_script": true,
               "crawler_other": true,
               "webshell": true,
               "cc": true,
               "custom": true,
               "whiteblackip": true,
               "ignore": true,
               "privacy": true,
               "antitamper": true
            },
           "level": 1,
           "full_detection": false,
           "hosts": ["11111111111111111", "2222222222222222222"],
           "timestamp": 1499817612
        }
     ]
}

状态码

表6描述的是API返回的正常状态码。
表6 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码,请参见状态码