文档中心

Web应用防火墙

CC 防护

ListCCRule - 查询 CC 防护规则详情

查询指定域名下的 CC 防护规则列表，展示规则组和规则信息。

注意事项

服务接口调用总上限：1000 QPS

单账号调用上限：50 QPS

请求说明

请求方式：POST

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：ListCCRule

接口名称。当前 API 的名称为 ListCCRule。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

CCType Integer[] 可选示例值：[0]

执行动作。

0：观察

1：限速

2：拦截

7：人机验证

Url String 可选示例值：/test/*

按请求路径模糊搜索。支持通配符 * ，* 仅可出现一次。

RuleTag String 可选示例值：F000000001193

按规则 ID 精确搜索。

RuleName String 可选示例值：true

按规则名称模糊搜索。

PathOrderBy String 可选示例值：ASC

列表显示顺序。

ASC：按请求路径升序。

DESC：按请求路径降序。

PageSize Integer 可选示例值：10

单个页面显示的规则条数，默认为 10，可设置范围为 1-100。

Page Integer 可选示例值：1

查询页码，默认为 1。

Host String 必选示例值：example.volcwaf001.com

需要设置防护规则的网站域名。

ProjectName String 可选示例值：default

当前资源关联的项目名称。项目名称获取方式参考ListProjectResources - 获取项目资源列表。

返回参数

PageSize Integer 示例值：10

每页返回的 CC 防护规则记录数量。

CurrentPage Integer 示例值：1

当前返回的CC防护规则列表的分页页码，用于标识分页查询结果的当前页位置。

TotalCount Integer 示例值：5

符合当前筛选条件的 CC 防护规则的总数量，用于分页场景下计算总页数或判断是否还有更多数据。

Count Integer 示例值：3

当前页返回的符合筛选条件的CC防护规则记录数量。

policyhandler.ListCCRuleRsp Object[] 示例值：-

符合筛选条件的 CC 防护规则列表，每个元素包含路径、规则组、插入时间、规则总数和已启用规则数等信息。

EnableCount Integer 示例值：1

当前路径下已启用的 CC 防护规则数量。

InsertTime String 示例值：2023-10-09T20:02:42Z

当前路径下 CC 防护规则首次录入系统的时间，格式遵循 ISO 8601 标准。

RuleGroup Object[] 示例值：-

按高级条件组聚合后的 CC 防护规则列表，每个元素包含高级条件组信息和该分组下的 CC 规则列表。

Group Object 示例值：-

高级条件组信息，为空表示当前路径下无高级条件分组。包含高级条件的 ID、子规则之间的逻辑关系、子规则列表及优先级等信息。

AccurateGroupPriority Integer 示例值：1

高级条件组的优先级，用于在列表展示时判定拖拽优先级时目标的位置。

AccurateRules Object[] 示例值：-

高级条件组中的子规则列表，每个子规则定义了具体的匹配条件（如请求头、客户端 IP 等），用于精确筛选符合条件的请求。

HttpObj String 示例值：request.header.clientip

匹配规则对应的具体对象。支持的匹配对象如下所示：

request.schema：请求协议；

request.uri：请求 URI；

request.method：请求方法；

request.path：请求路径；

request.queryargs：请求参数；

request.header：请求头；

request.header.ua：请求 User-Agent；

request.header.refer：请求 referer；

request.header.cookie：请求 Cookie 头；

request.header.content-length：请求体长度；

request.header.content-type：请求体格式；

request.header.x-forwarded-for：X-Forwarded-For；

request.header.clientip：客户端 IP；

request.queryargs.{Key}：自定义请求参数（需替换 {Key} 为具体参数名）；

request.header.{Key}：自定义请求头（需替换 {Key} 为具体头名称）；

request.cookie.{Key}：自定义 Cookie（需替换 {Key} 为具体 Cookie 名称）；

response.header：响应头；

response.body：响应体；

response.code：响应状态码；

response.header.content-type：响应头 content-type；

response.header.{Key}：自定义响应头（需替换 {Key} 为具体头名称）；

response.body.{Key}：响应体字段（需替换 {Key} 为具体字段名）；

request.ja3-hash：JA3 Hash；（仅 byteplus-global 地域适用）

注意：不能直接传递 request.queryargs.*、request.header.*、request.cookie.*、response.header.*、response.body.*这类泛化形式，必须携带具体的 Key。

ObjType Integer 示例值：12

匹配对象类型的枚举值，用于指定高级条件中子规则的匹配对象类型。支持的取值如下所示：

0：request.schema；

1：request.uri；

2：request.method；

3：request.path；

4：request.queryargs；

5：request.header；

6：request.header.ua；

7：request.header.refer；

8：request.header.cookie；

9：request.header.content-length；

10：request.header.content-type；

11：request.header.x-forwarded-for；

12：request.header.clientip；

13：request.queryargs.{Key}；

14：request.header.{Key}；

15：request.cookie.{Key}；

17：response.header；

18：response.body；

19：response.code；

20：response.header.content-type；

21：response.header.{Key}；

22：response.body.{Key}；

23：request.ja3-hash。（仅 byteplus-global 地域适用）

Opretar Integer 示例值：2

匹配操作符的枚举值，用于指定高级条件中子规则的匹配方式。支持的取值如下所示：

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；

22：保留值；

23：属于 IP 组；

24：不属于 IP 组；

25：属于 IP 地理位置；

26：不属于 IP 地理位置；

27：包含 IP 情报；

28：属于 ASN；

29：不属于 ASN。

Property Integer 示例值：0

匹配属性类型的枚举值，默认使用 0（除 IP 识别类特殊场景外）。支持的取值如下所示：

0：Value，适用于大部分匹配对象场景，如请求协议、URI、方法、请求头、客户端 IP、JA3 Hash 等；

5：IP，仅用于以下 IP 识别类操作

17（识别为 IP）

18（识别为 IPv4）

19（识别为 IPv6）

20（识别为私网 IP）

21（识别为公网 IP）

ValueString String 示例值：1.1.1.1

匹配规则对应的具体值。当匹配对象为request.header.{Key}、request.queryargs.{Key}或request.cookie.{Key}等泛化对象时，该字段表示对应Key的匹配值。特殊说明：当操作符（Opretar）为17、18、19、20、21且匹配对象（HttpObj）为request.header.clientip时，无需填写该字段；其余操作符场景均需按实际匹配值填写。

Id Integer 示例值：1

高级条件组的唯一标识 ID，创建规则时无需携带，仅在列表展示时用于聚合相关的 CC 防护规则。

Logic Integer 示例值：1

高级条件组中子规则之间的逻辑关系。支持的取值如下所示：

1：与（AND）；

2：或（OR）。

Rules Object[] 示例值：-

该高级条件分组下的 CC 防护规则列表，包含每个规则的详细配置信息。

AccurateGroup Object 示例值：-

高级条件组信息，当前路径与该条件组之间为 AND 关系，仅当请求同时命中路径和该条件组时规则才生效。

AccurateGroupPriority Integer 示例值：1

高级条件组的优先级，用于在列表展示时判定拖拽优先级时目标的位置。

AccurateRules Object[] 示例值：-

高级条件组中的子规则列表，每个子规则定义了具体的匹配条件（如请求头、客户端 IP 等），用于精确筛选符合条件的请求。

HttpObj String 示例值：request.header.clientip

匹配规则对应的具体对象。支持的匹配对象如下所示：

request.schema：请求协议；

request.uri：请求 URI；

request.method：请求方法；

request.path：请求路径；

request.queryargs：请求参数；

request.header：请求头；

request.header.ua：请求 User-Agent；

request.header.refer：请求 referer；

request.header.cookie：请求 Cookie 头；

request.header.content-length：请求体长度；

request.header.content-type：请求体格式；

request.header.x-forwarded-for：X-Forwarded-For；

request.header.clientip：客户端 IP；

request.queryargs.{Key}：自定义请求参数（需替换 {Key} 为具体参数名）；

request.header.{Key}：自定义请求头（需替换 {Key} 为具体头名称）；

request.cookie.{Key}：自定义 Cookie（需替换 {Key} 为具体 Cookie 名称）；

response.header：响应头；

response.body：响应体；

response.code：响应状态码；

response.header.content-type：响应头 content-type；

response.header.{Key}：自定义响应头（需替换 {Key} 为具体头名称）；

response.body.{Key}：响应体字段（需替换 {Key} 为具体字段名）；

request.ja3-hash：JA3 Hash；（仅 byteplus-global 地域适用）

注意：不能直接传递 request.queryargs.*、request.header.*、request.cookie.*、response.header.*、response.body.*这类泛化形式，必须携带具体的 Key。

ObjType Integer 示例值：12

匹配对象类型的枚举值，用于指定高级条件中子规则的匹配对象类型。支持的取值如下所示：

0：request.schema；

1：request.uri；

2：request.method；

3：request.path；

4：request.queryargs；

5：request.header；

6：request.header.ua；

7：request.header.refer；

8：request.header.cookie；

9：request.header.content-length；

10：request.header.content-type；

11：request.header.x-forwarded-for；

12：request.header.clientip；

13：request.queryargs.{Key}；

14：request.header.{Key}；

15：request.cookie.{Key}；

17：response.header；

18：response.body；

19：response.code；

20：response.header.content-type；

21：response.header.{Key}；

22：response.body.{Key}；

23：request.ja3-hash。（仅 byteplus-global 地域适用）

Opretar Integer 示例值：2

匹配操作符的枚举值，用于指定高级条件中子规则的匹配方式。支持的取值如下所示：

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；

22：保留值；

23：属于 IP 组；

24：不属于 IP 组；

25：属于 IP 地理位置；

26：不属于 IP 地理位置；

27：包含 IP 情报；

28：属于 ASN；

29：不属于 ASN。

Property Integer 示例值：0

匹配属性类型的枚举值，默认使用 0（除 IP 识别类特殊场景外）。支持的取值如下所示：

0：Value，适用于大部分匹配对象场景，如请求协议、URI、方法、请求头、客户端 IP、JA3 Hash 等；

5：IP，仅用于以下 IP 识别类操作

17（识别为 IP）

18（识别为 IPv4）

19（识别为 IPv6）

20（识别为私网 IP）

21（识别为公网 IP）

ValueString String 示例值：1.1.1.1

Id Integer 示例值：1

高级条件组的唯一标识 ID，创建规则时无需携带，仅在列表展示时用于聚合相关的 CC 防护规则。

Logic Integer 示例值：1

高级条件组中子规则之间的逻辑关系。支持的取值如下所示：

1：与（AND）；

2：或（OR）。

AccurateGroupPriority Integer 示例值：1

高级条件的优先级，创建或更新规则时无需指定该值，在列表展示场景中，可依据此优先级判断拖拽调整优先级时的目标位置。

CCType Integer 示例值：2

执行动作。

0：观察(observe)

1：限速(rate-limit)

2：拦截(block)

6：JS 挑战(js challenge)

7：人机验证(captcha)

CountTime Integer 示例值：60

统计时间窗口。单位秒，取值范围为 5~1800。

CronConfs Object[] 示例值：-

定时生效的配置列表，每个元素包含crontab表达式、该时段的路径总阈值和单对象阈值，仅当CronEnable为1时返回。

Crontab String 示例值：* 18-20 * * 1,2,3,4,5

crontab 表达式，需满足 confcenter 的 crontab 校验规则，推荐格式为 * <startHour>-<endHour> * * <weekList>（例如 * 18-20 * * 1,2,3,4,5），且同一规则内的周配置需保持一致，小时区间不能重叠。

PathThreshold Integer 示例值：500

定时生效时段内，该路径下的总体请求阈值，取值范围为 1 到 300000次。

SingleThreshold Integer 示例值：50

定时生效时段内，单个统计对象的请求次数阈值，取值范围为 1 到 300000次。

CronEnable Integer 示例值：1

定时生效开关，默认值为 0，表示规则始终生效。开启后必须同时配置 CronConfs。支持的取值如下所示：

0：关闭；

1：开启。

CustomResponsePageID String 示例值：123456

自定义响应页面的唯一标识 ID。为空字符串表示未配置该字段。使用前需确保用户已开通并有权限使用对应的自定义响应页面。

EffectTime Integer 示例值：3600

动作生效的时长，单位为秒，取值范围为 1~86400。当执行动作为限速、拦截、人机验证或 JS 挑战时，建议显式传入该字段。

Enable Integer 示例值：1

规则的开关状态。支持的取值如下所示：

0：关闭；

1：开启。

ExemptionTime Integer 示例值：300

人机验证或 JS 挑战的豁免时间，单位为秒，取值范围为 1~3600。用户在豁免时间内通过验证后可正常访问；豁免时间结束后若仍处于限制时长内，将再次触发验证。

Field String 示例值：CLIENTIP

统计对象，支持单个或多个字段，多个字段使用英文逗号分隔，最多 10 个。基础格式为 DataType:Value，例如 HEADER:Authorization、COOKIE:PHPSESSID、ARGS:device_id、CLIENTIP。支持的统计对象取值如下所示：

CLIENTIP：源 IP；

HEADER:{Header-Name}：指定请求头（Header-Name 需满足 HTTP 头 Key 规范）；

ARGS:{ArgName}：指定请求参数；

COOKIE:{CookieName}：指定 Cookie；

JA3HASH：JA3 Hash。（仅 byteplus-global 地域适用）

Host String 示例值：example.volcwaf001.com

需要保护的网站域名，调用前请确保该域名已添加到当前 WAF 实例。

Id Integer 示例值：12345

CC防护规则的唯一标识 ID。

Name String 示例值：商品详情页CC防护规则

CC防护规则的名称，需满足以下条件：

以中文、字母或数字开头。

允许使用中文、字母、数字、英文句点（.）、下划线（_）和中划线（-）

长度范围为1~128个字符。

PathThreshold Integer 示例值：1000

当前路径下的总体请求阈值，单位为次，取值范围为 1 到 300000。

RulePriority Integer 示例值：0

规则的优先级，取值范围为 0 到 9。其中 0 为最高优先级，9 为最低优先级。支持的取值如下所示。

0：最高优先级；

1：优先级 1；

2：优先级 2；

3：优先级 3；

4：优先级 4；

5：优先级 5；

6：优先级 6；

7：优先级 7；

8：优先级 8；

9：最低优先级。

RuleTag String 示例值：123456

规则的展示 ID，创建或更新规则时无需携带该字段，仅在列表展示场景中使用。

SingleThreshold Integer 示例值：1

单个统计对象的阈值.对外文档口径的取值范围为 1~300000,单位为次.

UpdateTime String 示例值：2023-10-09T20:02:42Z

规则最近更新的时间，仅用于列表展示场景。

Url String 示例值：/test.html

请求路径。可填写具体页面路径，也可匹配整站或某个目录下的全部路径。

通配符 * 只能出现在路径末尾，例如：/test.html/*

WSCdnByteThreshold Integer 示例值：1

WebSocket 字节数阈值，取值范围 1~10000000。

为 0 表示未配置。

WSCdnEnable Integer 示例值：0

WebSocket 统计防护的开关状态。开启后至少需要配置 WSCdnFrameThreshold 或 WSCdnByteThreshold 其中之一，且不支持再叠加 Cron 定时配置。支持的取值如下所示：

0：关闭；

1：开启。

WSCdnFrameThreshold Integer 示例值：1

WebSocket 帧数阈值，取值范围 1~10000。

为 0 表示未配置。

WSCdnUnit String 示例值：KB

WebSocket 字节数阈值单位：KB / MB / GB。

TotalCount Integer 示例值：1

当前路径下规则总数。

Url String 示例值：/test.html

请求路径。

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=ListCCRule&Version=2023-12-25

{
    "CCType": [
        0
    ],
    "Url": "/test/*",
    "RuleTag": "F000000001193",
    "RuleName": "true",
    "PathOrderBy": "ASC",
    "PageSize": 10,
    "Page": 1,
    "Host": "example.volcwaf001.com",
    "ProjectName": "default"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListCCRule",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageSize": 10,
        "CurrentPage": 1,
        "TotalCount": 15,
        "Count": 5,
        "EnableCount": 1,
        "InsertTime": "2024-01-02T19:56:47+08:00",
        "RuleGroup": [
            {
                "Group": {
                    "Logic": 1,
                    "AccurateRules": [
                        {
                            "HttpObj": "request.schema",
                            "ObjType": 0,
                            "Opretar": 2,
                            "Property": 0,
                            "ValueString": "http"
                        }
                    ]
                },
                "Rules": [
                    {
                        "Id": 126217,
                        "Url": "/test/*",
                        "Host": "example.volcwaf001.com",
                        "Name": "123",
                        "Field": "CLIENTIP",
                        "CCType": 0,
                        "Enable": 1,
                        "RuleTag": "F000000001193",
                        "CountTime": 60,
                        "CronConfs": [
                            {
                                "Crontab": "* 18-20 * * 1,2,3,4,5",
                                "PathThreshold": 1000,
                                "SingleThreshold": 100
                            }
                        ],
                        "CronEnable": 0,
                        "EffectTime": 100,
                        "UpdateTime": "2024-02-05T16:05:57+08:00",
                        "RulePriority": 0,
                        "AccurateGroup": {
                            "Logic": 1,
                            "AccurateRules": [
                                {
                                    "HttpObj": "request.schema",
                                    "ObjType": 0,
                                    "Opretar": 2,
                                    "Property": 0,
                                    "ValueString": "http"
                                }
                            ]
                        },
                        "ExemptionTime": 60,
                        "PathThreshold": 100,
                        "SingleThreshold": 10,
                        "AccurateGroupPriority": 9999999
                    }
                ]
            }
        ],
        "Url": "/test/*"
    }
}

最近更新时间：2026.06.03 17:05:16

这个页面对您有帮助吗？

有用

无用