查询指定域名下的 CC 防护规则详情。

请求说明

请求方式：GET

请求地址：https://advdefence.volcengineapi.com/?Action=DescWebDefCcRule&Version=2023-03-08

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

Action String 必选示例值：DescWebDefCcRule

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

Version String 必选示例值：2023-03-08

接口版本。当前 API 的版本为 2023-03-08。

CCRuleName String 可选示例值：TestRule

CC 规则名称。

CCRuleTag String 可选示例值：E000000000020

CC 规则 ID。

CurrPage Integer 可选示例值：1

当前页码。

Host String 必选示例值：www.test.com

防护域名。

PageSize Integer 可选示例值：10

每个页面展示的条目数量上限。

Url String 可选示例值：/test

请求路径。

返回参数

PageInfo Object 示例值：--

页面信息。

Count Integer

PageSize Integer

TotalCount Integer

CurrentPage Integer

Result Object[] 示例值：--

规则详情。

Url String 示例值：/cctest

规则组的请求路径。

RuleGroup Object[] 示例值：--

该路径下的规则组详情。

Group Object 示例值：--

具体特征条件下的规则组信息，如未设置更多特征匹配，则返回 NULL。

Id Integer 示例值：56697

规则组 ID。

Logic Integer 示例值：1

规则组中高级条件运算关系。

1：与

2：或

AccurateRules Object[] 示例值：--

规则组的请求特征信息。

HttpObj String 示例值：request.method

自定义对象，与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 示例值：2

匹配字段。

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 示例值：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

Property Integer 示例值：0

固定取值为 0，取 HttpObj 的值用于匹配对应详情。

ValueString String 示例值：GET

匹配内容。

说明

逻辑关系判断为 IP、 IPv4、 IPv6、私网 IP 或公网 IP 时不需要填写。

AccurateGroupPriority Integer 示例值：1073741824

规则创建完成后，自动生成的规则组优先级。

Rules Object[] 示例值：--

规则组详情。

Url String 示例值：/cctest

请求路径。

Host String 示例值：www.test.com

防护域名。

Name String 示例值：test

规则名称。

Field String 示例值：HEADER:User-Agent

统计对象，格式为类型:对应值。

CCType Integer 示例值：7

执行动作。

0：仅告警

1：限速

2：拦截

7：人机验证

DdosId Integer 示例值：1445

CC 规则 ID，可用于编辑和删除规则。

Enable Integer 示例值：1

是否启用规则。

0：关闭

1：启用

CCRuleTag String 示例值：E000000001445

CC 规则标识。

CountTime Integer 示例值：60

统计时长，单位：秒。

EffectTime Integer 示例值：60

生效时长，单位：秒。

说明

执行动作为"观察"时不返回该参数。

UpdateTime String 示例值：2024-05-09T11:40:00+08:00

规则更新时间。

PrefixSwitch Integer 示例值：0

是否开启前缀匹配。

0：关闭

1：开启

RulePriority Integer 示例值：0

规则执行优先级，数字越大优先级越低。

AccurateGroup Object 示例值：--

规则组信息。

PathThreshold Integer 示例值：100

请求路径访问的总次数阈值。

SingleThreshold Integer 示例值：10

每个统计对象访问的次数阈值。

AccurateGroupPriority Integer 示例值：1073741824

规则创建完成后，自动生成的规则组优先级。

TotalCount Integer 示例值：2

当前请求路径下的规则总数。

EnableCount Integer 示例值：2

当前请求路径下已开启的规则总数。

PrefixSwitch Integer 示例值：0

前缀匹配开关。

0：关闭

1：开启

请求示例

返回示例

DDoS防护