文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 云模式/ 防护策略/ 创建防护策略
更新时间：2022-12-29 GMT+08:00
查看PDF
分享

创建防护策略

功能介绍

创建防护策略。

URI

  • URI格式

    POST /v1/{project_id}/waf/policy

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

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    用户操作的项目ID。

请求消息

请求参数
表2 请求参数说明

名称

是否必选

参数类型

说明

name

是

String

防护策略名称。最大长度为256字符。只支持以数字、字母、下划线或中划线命名。

响应消息

响应参数
表3 响应参数说明

名称

参数类型

说明

id

String

防护实例的ID。

name

String

防护策略名称。

options

表4

防护规则是否开启。

action

表5

Web基础防护中的防护动作，默认为“log”模式。

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

level

Integer

防护等级。

  • “1”：表示低。
  • “2”：表示中。
  • “3”：表示高。

full_detection

Boolean

精准防护中的检测模式。

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基础防护中防护动作的类型，默认为“log”模式。

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

示例

如下以创建防护策略“policy_1”为例。

  • 请求样例 
    {
  "name": "policy_1"
}
  • 响应样例 
    {
          "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": [],
           "timestamp": 1499817612
}

状态码

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

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码，请参见状态码。

父主题： 防护策略