DescWebDefCcRule-查询 CC 防护规则--DDoS防护-火山引擎

文档中心

立即注册

导航

DescWebDefCcRule-查询 CC 防护规则

最近更新时间：2024.07.19 19:17:47首次发布时间：2024.07.19 19:17:47

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

请求说明

请求方式：GET
请求地址：https://open.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 of PageInfo	`--`	页面信息。
Result	Array of WafCCV3Result	`--`	规则详情。

PageInfo

参数	类型	示例值	描述
Count	Integer	`10`	当前页面显示的条目数量。
PageSize	Integer	`10`	单个页面显示的条目数量上限。
TotalCount	Integer	`15`	查询到的符合条件的条目总数。
CurrentPage	Integer	`1`	当前页面的页码。

WafCCV3Result

参数	类型	示例值	描述
Url	String	`/cctest`	规则组的请求路径。
RuleGroup	Array of RuleGroup	`--`	该路径下的规则组详情。
TotalCount	Integer	`2`	当前请求路径下的规则总数。
EnableCount	Integer	`2`	当前请求路径下已开启的规则总数。
PrefixSwitch	Integer	`0`	前缀匹配开关。 0：关闭 1：开启

RuleGroup

参数	类型	示例值	描述
Group	Object of WafV3Accurate	`--`	具体特征条件下的规则组信息，如未设置更多特征匹配，则返回 NULL。
Rules	Array of WafCCV3Rules	`--`	规则组详情。

WafV3Accurate

参数	类型	示例值	描述
Id	Integer	`56697`	规则组 ID。
Logic	Integer	`1`	规则组中高级条件运算关系。 1：与 2：或
AccurateRules	Array of WafAccurateRuleItem	`--`	规则组的请求特征信息。
AccurateGroupPriority	Integer	`1073741824`	规则创建完成后，自动生成的规则组优先级。

WafAccurateRuleItem

参数	类型	示例值	描述
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 时不需要填写。

WafCCV3Rules

参数	类型	示例值	描述
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 of WafV3Accurate	`--`	规则组信息。
PathThreshold	Integer	`100`	请求路径访问的总次数阈值。
SingleThreshold	Integer	`10`	每个统计对象访问的次数阈值。
AccurateGroupPriority	Integer	`1073741824`	规则创建完成后，自动生成的规则组优先级。

请求示例

GET https://open.volcengineapi.com/?Action=DescWebDefCcRule&Version=2023-03-08&Host=www.test.com
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240715210620****845D7DB7984C236A",
        "Action": "DescWebDefCcRule",
        "Version": "2023-03-08",
        "Service": "AdvDefence",
        "Region": "cn-beijing"
    },
    "Result": [
        {
            "TotalCount": 1,
            "EnableCount": 1,
            "RuleGroup": [
                {
                    "Group": null,
                    "Rules": [
                        {
                            "CCRuleTag": "E000000009995",
                            "DdosId": 9995,
                            "Id": 22371,
                            "Host": "bugfix11.volcddos.com",
                            "Name": "testdd",
                            "Url": "/*",
                            "Enable": 1,
                            "CCType": 1,
                            "Field": "CLIENTIP",
                            "SingleThreshold": 5,
                            "PathThreshold": 1,
                            "CountTime": 10,
                            "EffectTime": 300,
                            "AccurateGroupPriority": 0,
                            "RulePriority": 0,
                            "PrefixSwitch": 0,
                            "UpdateTime": "2024-07-12T17:15:01+08:00"
                        }
                    ]
                }
            ],
            "Url": "/*",
            "PrefixSwitch": 0
        }
    ],
    "PageInfo": {
        "TotalCount": 1,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 1
    }
}