Web 应用防火墙：CreateDefenseRule - 创建Web核心防护规则

名称

类型

是否必选

示例值

描述

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

action

String

必选

block

防护规则动作。取值：
- block：表示拦截。
- monitor：表示观察。

policyId

Long

可选

1012

防护规则组ID。默认为中等规则组1012。

protectionType

String

可选

sema

防护规则类型。取值：
- regular（默认）：表示正则防护。
- sema：表示语义防护。

config

String

可选

{"nonInjectionSql":1}

自定义配置信息，以JSON字符串格式表示。具体配置信息，请参见config详细配置。

名称

类型

是否必选

示例值

描述

nonInjectionSql

Integer

必选

1

非注入型攻击检测状态。取值：
- 0：表示关闭。
- 1（默认）:表示开启。

名称

类型

是否必选

示例值

描述

protectionType

String

必选

highfreq

扫描防护规则子类型。取值：
- highfreq：表示高频扫描封禁。
- dirscan：表示目录遍历封禁。
- scantools：表示扫描工具封禁。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

action

String

必选

block

防护规则动作。取值：
- block：表示拦截。
- monitor：表示观察。

config

String

可选

{"target":"remote_addr","interval":60,"ttl":180,"count":20}

自定义配置信息，以JSON字符串格式进行描述。具体配置信息，请参见config详细配置。

名称

类型

是否必选

示例值

描述

target

String

必选

remote_addr

统计对象类型。取值：
- remote_addr（默认)：表示IP。
- cookie.acw_tc：表示会话。
- header：表示自定义Header。选择自定义Header时，必须在subkey参数中填写需要统计的Header内容。
- queryarg：表示自定义参数。选择自定义参数时，必须在subkey参数中填写需要统计的自定义参数名称。
- cookie：表示自定义Cookie。选择自定义Cookie时，必须在subkey参数中填写需要统计的Cookie内容。

subKey

String

可选

abc

统计对象的子特征。当target参数值为cookie、header或queryarg时，必须在subkey参数中填写对应的信息。

interval

Integer

可选

60

检测时长，单位为秒。默认为60秒。
取值范围为：5~1800秒。

ttl

Integer

可选

1800

封禁时长，单位为秒。默认为1800秒。
取值范围为：60~86400秒。

count

Integer

可选

20

基础防护规则触发最大次数。默认为20次。
取值范围为：3~50000次。

ruleIdCount

Integer

可选

2

触发的最大规则数。默认为2条。
取值范围为：1~50条。

名称

类型

是否必选

示例值

描述

target

String

必选

remote_addr

统计和封禁对象。取值：
- remote_addr（默认)：表示IP。
- cookie.acw_tc：表示会话。
- header：表示自定义Header。
- queryarg：表示自定义参数。
- cookie：表示自定义Cookie。

subKey

String

可选

1

统计和封禁对象的子特征。仅target配置为header、queryarg、cookie时，配置该信息。

interval

Integer

可选

60

检测时长，单位为秒。默认为60秒。
取值范围为：5~1800秒。

ttl

Integer

可选

1800

封禁时长，单位为秒。默认为1800秒。
取值范围为：60~86400秒。

count

Integer

可选

20

基础防护规则触发最大次数。默认为20次。
取值范围为：3~50000次。

weight

Float

可选

2

404响应码百分比。默认为0.7。
取值范围为：0.01~1.0，精确到小数点后两位。

uriNum

Integer

可选

2

不存在的最大目录数。默认为50个。
取值范围为：2~50000个。

名称

类型

是否必选

示例值

描述

name

String

必选

iptest

IP黑名单规则名称。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

action

String

必选

block

防护规则动作。取值：
- block：表示拦截。
- monitor：表示观察。

remoteAddr

Array

必选

["1.1.XX.XX", "3.1.XX.XX/24"]

要加入的IP黑名单列表。使用["ip1","ip2",……]格式表示。

名称

类型

是否必选

示例值

描述

name

String

必选

iptest

自定义ACL规则名称。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

action

String

必选

block

防护规则动作。取值：
- block：表示拦截。
- monitor：表示观察。
- js：表示JS校验。
- captcha：表示滑块。
- captcha_strict：表示严格滑块。
说明 自定义ACL支持的防护规则动作，请以WAF控制台中展示的自定义规则动作为准。

conditions

Array

必选

[{"key":"IP","opValue":"eq","values":"11.XX.XX.1"},{"key":"Header","subKey":"abc","opValue":"contains","values":"test"}]

ACL的流量特征，以JSON字符串格式进行描述，支持填写最多五个匹配条件。具体配置信息，请参见conditions详细配置。

ccStatus

Integer

必选

1

是否开启限速。取值：
- 0：表示关闭限速。
- 1：表示开启限速。

ratelimit

JSON

可选

{"target":"remote_addr","interval":5,"threshold":2,"ttl":1800,"status":{"code":404,"count":2}}

限速详细配置，以JSON字符串格式进行描述，仅ccStatus配置为1时，配置该信息。具体配置信息，请参见ratelimit详细配置。

effect

String

可选

rule

设置限速生效范围，仅ccStatus配置为1时，配置该信息。取值：
- service：表示生效对象为防护对象。
- rule：表示生效对象为单规则。

名称

类型

是否必选

示例值

描述

key

String

必选

IP

匹配字段。取值：URL、URLPath、IP、Referer、User-Agent、Params、Cookie、Content-Type、Content-Length、X-Forwarded-For、Post-Body、Http-Method、Header。

subKey

String

可选

abc

自定义子匹配字段。
说明 并不是每一个自定义规则的匹配字段（key）都有自定义子匹配字段（subKey）。关于不同匹配字段是否支持自定义子匹配字段，请以WAF控制台自定义规则中匹配字段和自定义匹配字段的关系为准。

opValue

String

必选

contain

逻辑符。取值：
- not-contain：表示不包含。
- contain：表示包含。
- none：表示不存在。
- ne：表示不等于。
- eq：表示等于。
- lt：表示值小于。
- gt：表示值大于。
- len-lt：表示长度小于。
- len-eq：表示长度等于。
- len-gt：表示长度大于。
- not-match：表示不匹配。
- match-one：表示等于多值之一。
- all-not-match：表示不等于任一值。
- all-not-contain：表示不包含任一值。
- contain-one：表示包含多值之一。
- not-regex：表示正则不匹配。
- regex：表示正则匹配。
- all-not-regex：表示正则均不匹配。
- regex-one：表示正则匹配其中之一。
- prefix-match：表示前缀匹配。
- suffix-match：表示后缀匹配。
- empty：表示内容为空。
- exists：表示字段存在。
- inl：表示在列表中。
说明 并不是每一个自定义规则的匹配字段（key）都能对应配置全部的逻辑符（opValue）。关于不同匹配字段支持使用的逻辑符，请以WAF控制台自定义规则中匹配字段和逻辑符的关联关系为准。

values

String

必选

abc

匹配内容，根据需要填写相应的内容。
说明 匹配条件参数中的逻辑符（opValue）、匹配内容（values）参数取值范围与所指定的匹配字段（key）相关。

名称

类型

是否必选

示例值

描述

target

String

必选

remote_addr

统计对象类型。取值：
- remote_addr（默认)：表示IP。
- cookie.acw_tc：表示会话。
- header：表示自定义Header。选择自定义Header时，必须在subkey参数中填写需要统计的Header内容。
- queryarg：表示自定义参数。选择自定义参数时，必须在subkey参数中填写需要统计的自定义参数名称。
- cookie：表示自定义Cookie。选择自定义Cookie时，必须在subkey参数中填写需要统计的Cookie内容。

subKey

String

可选

abc

统计对象的子特征。当target参数值为cookie、header或queryarg时，必须在subkey参数中填写对应的信息。

interval

Integer

必选

60

统计时长，单位为秒。即访问次数的统计周期，与阈值（threshold）参数配合。
取值范围为：5~1800秒。

threshold

Integer

必选

200

在检测时长内，允许单个统计对象访问被防护地址的次数阈值。

ttl

Integer

必选

1800

处置动作的生效时长，单位为秒。
取值范围为：60~86400秒。

status

JSON

可选

{"code":404,"count":200}

响应码频率设置。以JSON字符串格式进行描述，具体包含以下参数：
code：Integer类型，必选 ，指定响应码。
count：Integer类型 ，可选，出现次数阈值，即表示当指定的响应码出现次数超过该阈值时命中防护规则。取值范围：2-50000次。count参数与ratio参数两者选其一，不可同时配置。
ratio：Integer类型 ，可选 ，出现比例阈值（百分比），即表示当指定的响应码出现比例超过该阈值时命中防护规则。取值范围：1-100。count参数与ratio参数两者选其一，不可同时配置。

名称

类型

是否必选

示例值

描述

name

String

必选

whitelistTest

白名单规则名称。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

conditions

Array

必选

[{"key":"IP","opValue":"eq","values":"11.XX.XX.1"},{"key":"Header","subKey":"abc","opValue":"contains","values":"test"}]

白名单的流量特征，以JSON字符串格式进行描述，支持填写最多五个匹配条件。具体配置信息，请参见conditions详细配置。

tags

Array

必选

["waf", "regular"]

白名单作用模块列表，使用["XX1", "XX2",……]格式。取值：
- waf：表示全部模块。
- customrule：表示自定义规则。
- blacklist：表示IP黑名单。
- antiscan：表示扫描防护。
- regular：表示基础防护规则。
- regular_rule：表示基础防护特定正则规则。
- regular_type：表示基础防特定正则规则类型。
- major_protection：表示重保场景防护。
- cc：表示CC防护。
- region_block：表示区域封禁。
- antibot_scene：表示BOT场景防护。
- dlp：表示信息泄露防护。
- tamperproof：表示网页防篡改。

regularRules

Array

可选

[ "111111", "222222" ]

不检测正则规则ID列表，使用["XX1", "XX2",……]格式。仅白名单作用模块配置为基础防护特定正则规则（tags参数取值为regular_rule）时，配置该参数。

regularTypes

Array

可选

[ "xss", "css" ]

不检测正则规则类型列表，使用["XX1", "XX2",……]格式。仅白名单作用模块配置为Web应用正则类型（tags参数取值为regular_type）时，配置该参数。取值：
- sqli：表示SQL注入。
- xss：表示跨站脚本。
- code_exec：表示代码执行。
- crlf：表示CRLF。
- lfilei：表示本地文件包含。
- rfilei：表示远程文件包含。
- webshell：表示WebShell。
- csrf：表示CSRF。
- other：表示其他。

名称

类型

是否必选

示例值

描述

key

String

必选

IP

匹配字段。取值：URL、URLPath、IP、Referer、User-Agent、Params、Cookie、Content-Type、Content-Length、X-Forwarded-For、Post-Body、Http-Method、Header。

subKey

String

可选

abc

自定义子匹配字段。
说明 并不是每一个白名单规则的匹配字段（key）都有自定义子匹配字段（subKey）。关于不同匹配字段是否支持自定义子匹配字段，请以WAF控制台白名单规则中匹配字段和自定义匹配字段的关系为准。

opValue

String

必选

contain

逻辑符。取值：
- not-contain：表示不包含。
- contain：表示包含。
- none：表示不存在。
- ne：表示不等于。
- eq：表示等于。
- lt：表示值小于。
- gt：表示值大于。
- len-lt：表示长度小于。
- len-eq：表示长度等于。
- len-gt：表示长度大于。
- not-match：表示不匹配。
- match-one：表示等于多值之一。
- all-not-match：表示不等于任一值。
- all-not-contain：表示不包含任一值。
- contain-one：表示包含多值之一。
- not-regex：表示正则不匹配。
- regex：表示正则匹配。
- all-not-regex：表示正则均不匹配。
- regex-one：表示正则匹配其中之一。
- prefix-match：表示前缀匹配。
- suffix-match：表示后缀匹配。
- empty：表示内容为空。
- exists：表示字段存在。
- inl：表示在列表中。
说明 并不是每一个白名单规则的匹配字段（key）都能对应配置全部的逻辑符（opValue）。关于不同匹配字段支持使用的逻辑符，请以WAF控制台白名单规则中匹配字段和逻辑符的关联关系为准。

values

String

必选

abc

匹配内容，根据需要填写相应的内容。
说明 匹配条件参数中的逻辑符（opValue）、匹配内容（values）参数取值范围与所指定的匹配字段（key）相关。

名称

类型

是否必选

示例值

描述

responseType

String

必选

response_block

自定义响应的类型。取值response_block，表示拦截响应。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

config

String

必选

{"responseCode":400,"responseHeaders":[{"key":"custom","value":"123"},{"key":"aaa","value":"2223"}],"responseContent":"HelloWorld"}

自定义配置信息，以JSON字符串格式进行描述。具体配置信息，请参见config详细配置。

名称

类型

是否必选

示例值

描述

responseCode

Integer

必选

400

指定响应码。

responseHeaders

Array

可选

[{"key":"custom","value":"123"},{"key":"aaaa","value":"2223"}]

自定义响应头列表，以JSON字符串格式进行描述。key为header的字段，value为header的值。

responseContent

String

必选

helloworld

自定义响应的内容。

名称

类型

是否必选

示例值

描述

cnRegionList

String

可选

610000,230000

中国境内区域列表，只填写["CN"]，表示封禁中国内地区域（除港澳台）。多个区域之间使用英文逗号（,）分隔。关于地域代码的具体含义，请参见中国境内地域代码含义说明。

abroadRegionList

String

可选

KE,KG

中国境外区域列表，多个区域之间使用英文逗号（,）分隔。关于地域代码的具体含义，请参见中国境外地域代码含义说明。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

action

String

必选

block

防护规则动作。取值：
- block：表示拦截。
- monitor：表示观察。

名称

类型

是否必选

示例值

描述

mode

Integer

必选

0

CC防护模式。取值：
- 0（默认）：表示普通防护。
- 1：表示紧急防护。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

名称

类型

是否必选

示例值

描述

name

String

必选

test

防护规则名称。

url

String

必选

/abc

缓存页面的地址。

ua

String

可选

app

指定user-agent访问该路径。

protocol

String

必选

https

缓存页面地址的协议类型。取值：http、https。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

名称

类型

是否必选

示例值

描述

name

String

必选

test

防护规则名称。

conditions

Array

必选

[{"key":"HttpCode","opValue":"contain","values":"400,401,402,403,404,405,500,501,502,503,504,505"},{"key":"URL","opValue":"contain","values":"test"}]

匹配条件，以JSON字符串格式进行描述，支持设置最多两条匹配条件且条件间的关系为并且。具体配置信息，请参见conditions详细配置。

status

Integer

必选

1

防护规则状态。该参数仅用于创建防护规则，修改防护规则状态时使用ModifyDefenseRuleStatus接口的RuleStatus参数。取值：
- 0：表示关闭。
- 1（默认）：表示开启。

action

String

必选

block

防护规则动作。取值：
- block：表示拦截，该动作仅适用于包含响应码匹配条件场景。
- monitor：表示观察。
- filter：表示敏感信息过滤，该动作仅适用于包含敏感信息匹配条件场景。

名称

类型

是否必选

示例值

描述

key

String

必选

URL

匹配字段。取值：URL、HttpCode、SensitiveInfo。

opValue

String

必选

contain

逻辑符。固定取值contain。

values

String

必选

abc

匹配内容，多个匹配内容之间使用逗号（,）分隔。
HttpCode对应取值为：400、401、402、403、404、405（代表405-499）、500、501、502、503、504、505（代表505-599）。
SensitiveInfo对应取值为：
- phone：表示电话号码。
- card：表示信用卡。
- id：表示身份证。
- word：表示默认敏感词。