CreateCCRule-创建 CC 防护规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

CreateCCRule-创建 CC 防护规则

最近更新时间：2025.05.30 18:26:23首次发布时间：2023.11.10 18:24:47

调用 CreateCCRule 接口创建 CC 防护规则，根据网络访问 IP、Session 等各种 HTTP 请求对象进行请求限制。当满足设定的统计条件后，对后续请求执行防护动作，以防止服务器资源被过度占用，确保正常访问业务不受影响。

请求说明

请求方式：POST
请求地址：https://waf.volcengineapi.com/?Action=CreateCCRule&Version=2023-12-25

请求参数

参数	类型	是否必填	示例值	描述
Name	String	是	`123`	规则名称。以中文、字母、数字开头。允许字母、数字、中文、点“.”、下划线“_”和中划线“-”。长度为1-128个字符。
Url	String	是	`/test/*`	需要防护的网站请求路径，可以是具体的某个页面路径，也可以是整个网站下的所有路径。匹配具体路径：某个具体的页面路径，例如需要拦截对`test.com/test.html`的访问，则直接填写域名后的路径信息`/test.html`即可。匹配目录下全部路径：使用``可以匹配全部路径，且``需在路径末尾。匹配整个网站下的所有路径，则填写`/`即可。匹配某个目录下的全部路径，则在对应目录路径下使用``即可。例如`/test/`，表示匹配`/test/`目录下的全部路径。注意 `/test//abc.html`和`/test/*`都表示匹配`/test/`目录下的全部路径。
AdvancedEnable	Boolean	否	`true`	是否启用高级条件。 true：启用。 false：不启用。请求路径与高级条件之间为`且`的关系，即当请求路径和高级条件都满足，方可触发规则。多请求路径匹配：如需规则对多个请求路径生效，请先配置主请求路径为目录下的全部路径，再添加匹配字段为请求路径的条件。例如需要配置`/test/123.html`和`/test/abc.jpg`，则可参考如下操作：将请求路径设置为`/test/*`。增加 2 条条件：条件 1：`请求路径`等于`/test/123.html` 条件 2：`请求路径`等于`/test/abc.jpg` 两者条件关系设置为`2`（或）。
Field	String	是	`CLIENTIP`	统计对象，多个对象用逗号分隔。格式为`类型:对应值`。自定义 Header。格式为`HEADER:具体参数`，例如`HEADER:Authorization` 自定义 Cookie。格式为`COOKIE:具体参数`，例如`COOKIE:PHPSESSId`。自定义参数。格式为`ARGS:具体参数`，例如`ARGS:device_Id`。源 IP。直接配置为`CLIENTIP`。
SingleThreshold	Integer	是	`10`	每个统计对象访问请求路径的次数阈值，单位：次，取值范围 1~300,000。
PathThreshold	Integer	是	`100`	请求路径被访问的总次数阈值，单位：次，取值范围 1~300,000。
CountTime	Integer	是	`60`	策略的统计周期，单位：秒。取值范围 5～1,800。
CCType	Integer	是	`0`	满足统计条件后对后续请求执行的动作，关于执行动作的详细说明请参考执行动作说明。 0：观察 1：限速 2：拦截 6：JS 挑战 7：人机验证
EffectTime	Integer	是	`100`	限制时长，即动作的生效时长，单位：秒。取值范围 1～86,400。当策略执行动作为`限速`、`人机验证`或`JS 挑战`时需要设置。例如设置拦截动作的限制时长为 60 秒，则触发策略后，后续请求将被限制在 60 秒内无法访问目标路径。
RulePriority	Integer	是	`0`	规则执行优先级，数字越大优先级越低。同一请求特征下的 CC 防护规则优先级不可重复。 0：P0 1：P1 2：P2 3：P3 4：P4 5：P5 6：P6 7：P7 8：P8 9：P9
Enable	Enum	是	`1`	是否启用规则。 0：不启用 1：启用
AccurateGroup	AccurateGroupobject	否	-	高级条件配置，未开启高级条件时无需配置此字段。
Host	String	是	`example.volcwaf001.com`	需要设置防护规则的网站域名，请确保输入的域名已经添加到 WAF 实例。
ExemptionTime	Integer	否	60	策略豁免时间，当策略执行动作为`人机验证`或`JS 挑战`时需要设置。当请求行为触发以上防护动作并验证通过之后，流量在豁免时间内可以正常访问目标域名。豁免时间到期后，如果仍处于策略限制时长范围内，则 WAF 会重新发起人机验证、JS 挑战或工作量证明，通过后才能访问。
CronEnable	Integer	否	0	是否设置周期循环生效，开启后，可在每周固定时间内执行该策略，支持配置多个生效时段。默认为不开启，即永久生效。 0：不开启 1：开启，需要配置每周生效开始时间和结束时间。
CronConfs	Array of CronConf objects	否	--	周期循环配置详情。
ProjectName	String	否	default	所属项目资源名称，获取方式可参考ListDomain-查询云 WAF 实例防护网站信息。

AccurateGroup

参数	类型	是否必填	示例值	描述
AccurateRules	Array of AccurateRules objects	是	-	规则详情。
Logic	Integer	是	`1`	规则间的运算关系。 1：与 2：或

参数

类型

是否必填

示例值

描述

AccurateRules

Array of AccurateRules objects

是

规则详情。

Logic

Integer

是

1

规则间的运算关系。

1：与
2：或

AccurateRules

参数	类型	是否必填	示例值	描述
HttpObj	String	是	`request.schema`	自定义对象，与`ObjType`存在映射关系。请求协议：`request.schema` 请求 uri：`request.uri` 请求方法：`request.method` 请求路径：`request.path` 请求参数：`request.queryargs` 请求头：`request.header` 请求 User-Agent：`request.header.ua` 请求 refer：`request.header.refer` 请求 Cookies：`request.header.cookies` 请求体长度：`request.header.content-length` 请求体格式：`request.header.content-type` X-forwarded-for：`request.header.x-forwarded-for` 客户端 IP：`request.header.clientip` 自定义 Args：`request.queryargs.自定义参数名称`。例如`request.queryargs.abc`。自定义 header：`request.header.自定义Header 名称`。例如`request.header.abc`。自定义 cookie：`request.cookie.自定义 cookie 名称`。例如`request.cookie.abc`。
ObjType	Integer	是	`0`	匹配字段。 0：请求协议 1：请求 uri 2：请求方法 3：请求路径 4：请求参数 5：请求头 6：请求 User-Agent 7：请求 refer 8：请求 Cookies 9：请求体长度 10：请求体格式 11：X-forwarded-for 12：客户端 IP 13：自定义 Args 14：自定义 header 15：自定义 cookie
Opretar	Integer	是	`0`	逻辑运算符。 0：大于 1：大于等于 2：等于 3：小于 4：小于等于 5：不等于 6：包含子串 7：不包含子串 8：包含前缀 9：不包含前缀 10：包含后缀 11：不包含后缀 12：包含所有匹配集合 13：不包含所有匹配集合 14：属于匹配集合 15：不属于匹配集合 16：正则 17：判断为 IP 18：判断为 IPv4 19：判断为 IPv6 20：判断为私网 IP 21：判断为公网 IP
Property	Integer	是	`0`	固定取值为 0，取`HttpObj`的值用于匹配对应详情。
ValueString	string	是	`123`	匹配内容。逻辑关系判断为 IP、 IPv4、 IPv6、私网 IP 或公网 IP 时不需要填写。

CronConf

参数	类型	是否必填	示例值	描述
Crontab	String	是	`* 18-20 * * 1,2,3,4,5`	每周的循环日和循环时间段，固定格式为`* <循环起始时间>-<循环结束时间> * * <循环日>`。例如：`* 18-20 * * 1,2,3,4,5`表示周一至周五每天 18:00-20:00 执行策略。`* 0-6 * * 6,0`表示周六、周日每天 00:00-06:00 执行策略。循环日取值： 1：周一 2：周二 3：周三 4：周四 5：周五 6：周六 0：周日循环时间取值：当前支持设置整点时间。例如需要策略在 00:00-07:59 生效执行，则填写`0-7`。
PathThreshold	Integer	是	`1000`	请求路径访问的次数阈值。取值范围 1~300,000。
SingleThreshold	Integer	是	`100`	每个统计对象访问的次数阈值。取值范围 1~300,000。

参数

类型

是否必填

示例值

描述

Crontab

String

是

* 18-20 * * 1,2,3,4,5

每周的循环日和循环时间段，固定格式为* <循环起始时间>-<循环结束时间> * * <循环日>。例如：* 18-20 * * 1,2,3,4,5表示周一至周五每天 18:00-20:00 执行策略。* 0-6 * * 6,0表示周六、周日每天 00:00-06:00 执行策略。

循环日取值：
- 1：周一
- 2：周二
- 3：周三
- 4：周四
- 5：周五
- 6：周六
- 0：周日
循环时间取值：当前支持设置整点时间。例如需要策略在 00:00-07:59 生效执行，则填写0-7。

PathThreshold

Integer

是

1000

请求路径访问的次数阈值。取值范围 1~300,000。

SingleThreshold

Integer

是

100

每个统计对象访问的次数阈值。取值范围 1~300,000。

返回参数

参数	类型	示例值	描述
Id	String	`69674`	创建的规则 ID。

请求示例

POST https://waf.volcengineapi.com/?Action=CreateCCRule&Version=2020-12-09
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
    "ProjectName": "default",
    "ExemptionTime": 60,
    "Name": "CC规则1",
    "Url": "/*",
    "AdvancedEnable": true,
    "Field": "HEADER:User-Agent",
    "CountTime": 60,
    "CronEnable": 1,
    "CCType": 6,
    "RulePriority": 1,
    "Enable": 1,
    "AccurateGroup": {
        "Logic": 2,
        "AccurateRules": [
            {
                "Property": 0,
                "HttpObj": "request.schema",
                "ObjType": 0,
                "Opretar": 2,
                "ValueString": "HTTP"
            },
            {
                "Property": 0,
                "HttpObj": "request.method",
                "ObjType": 2,
                "Opretar": 2,
                "ValueString": "POST"
            }
        ]
    },
    "EffectTime": 60,
    "CronConfs": [
        {
            "PathThreshold": 1000,
            "SingleThreshold": 100,
            "Crontab": "* 0-5 * * 1,2,3,4,5"
        },
        {
            "PathThreshold": 2000,
            "SingleThreshold": 200,
            "Crontab": "* 21-23 * * 1,2,3,4,5"
        }
    ],
    "Host": "****.access.omni-shield.volces.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250519212146D9B0474EF827BA54****",
        "Action": "CreateCCRule",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": 69674
    }
}