ListCCRule-查询 CC 防护规则详情--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListCCRule-查询 CC 防护规则详情

最近更新时间：2024.03.01 16:47:37首次发布时间：2023.11.10 18:24:47

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListCCRule&Version=2020-12-09

请求参数

参数	类型	是否必填	示例值	描述
CCType	Integer	否	`1`	执行动作筛选。 0：告警 1：限速 2：拦截 7：人机验证
Host	String	是	`example.volcwaf001.com`	需要设置防护规则的网站域名。
Page	Integer	否	`1`	查询页码，默认为 1。
PageSize	Integer	否	`20`	单个页面显示的规则条数，默认为 10，可设置范围为 1-100。
PathOrderBy	Enum	否	`ASC`	列表显示顺序。 ASC：按请求路径升序。 DESC：按请求路径降序。
RuleName	String	否	`123`	按规则名称模糊搜索。
RuleTag	String	否	`144565`	按规则 ID 精确搜索。
Url	String	否	`/test.html`	按请求路径模糊搜索。

返回参数

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

Data

参数	类型	示例值	描述
Url	String	`/12345.html`	规则组的请求路径。
TotalCount	Integer	`2`	规则组内的规则总数。
EnableCount	Integer	`1`	规则组内已开启的规则总数。
InsertTime	String	`2023-10-09T19:50:52+08:00`	规则组的创建时间。
RuleGroup	Array of RuleGroup objects	-	规则组详情。

RuleGroup

参数	类型	示例值	描述
Group	Group object	-	规则组信息。
Rules	Array of Rules objects	-	规则组内具体规则信息。

Group

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

AccurateRules

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

Rules

参数	类型	示例值	描述
Id	String	`123456`	规则 ID。
Name	String	`test`	规则名称。
Host	String	`example.volcwaf001.com`	防护的网站域名。
Url	String	`/test/*`	请求路径。
Enable	Enum	`1`	规则是否启用。 0：不启用 1：启用
SingleThreshold	Integer	`10`	每个统计对象访问的次数阈值。
PathThreshold	Integer	`100`	请求路径访问的次数阈值。
AccurateGroupPriority	Integer	`1073741824`	规则创建完成后，自动生成的规则组优先级。
RulePriority	Integer	`0`	规则执行优先级，数字越大优先级越低。 0：P0 1：P1 2：P2 3：P3 4：P4 5：P5 6：P6 7：P7 8：P8 9：P9
CCType	Integer	`0`	执行动作。 0：观察 1：限速 2：拦截 7：人机验证
Field	String	`HEADER:Authorization`	统计对象，多个对象用逗号分隔。格式为`类型:对应值`。 `HEADER:具体参数`表示统计对象为自定义 Header。例如`HEADER:Authorization`。 `COOKIE:具体参数`表示统计对象为自定义 Cookie。例如`COOKIE:PHPSESSId`。 `ARGS:具体参数`表示自定义参数。例如`ARGS:device_Id`。 `CLIENTIP`表示统计对象为源 IP。
CountTime	Integer	`60`	统计时长，单位：秒。
EffectTime	Integer	`100`	统计时长，单位：秒。执行动作为“观察”时不返回该参数。
AccurateGroup	AccurateGroup object		规则组信息。
RuleTag	String	`E000000144566`	规则标签，即完整的规则 ID。
UpdateTime	String	`2023-10-09T19:50:52+08:00`	规则更新时间。

AccurateGroup

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

请求示例

POST https://open.volcengineapi.com/?Action=ListCCRule&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***

{
  "Host": "example.volcwaf001.com",
  "Page": 1,
  "PageSize": 10,
  "PathOrderBy": "DESC",
  "RuleName": "111"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202310092036010E23DB0E02EDBDDC****",
        "Action": "ListCCRule",
        "Version": "2020-12-09",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 1,
        "Data": [
            {
                "Url": "/12345.html",
                "TotalCount": 1,
                "EnableCount": 1,
                "InsertTime": "2023-10-09T19:50:52+08:00",
                "RuleGroup": [
                    {
                        "Group": {
                            "Id": 56697,
                            "AccurateGroupPriority": 1073741824,
                            "Logic": 2,
                            "AccurateRules": [
                                {
                                    "HttpObj": "request.method",
                                    "ObjType": 2,
                                    "Property": 0,
                                    "Opretar": 2,
                                    "ValueString": "GET"
                                },
                                {
                                    "HttpObj": "request.method",
                                    "ObjType": 2,
                                    "Property": 0,
                                    "Opretar": 2,
                                    "ValueString": "POST"
                                }
                            ]
                        },
                        "Rules": [
                            {
                                "Id": 144566,
                                "Name": "111",
                                "Host": "example.volcwaf001.com",
                                "Url": "/12345.html",
                                "Enable": 1,
                                "SingleThreshold": 10,
                                "PathThreshold": 100,
                                "AccurateGroupPriority": 1073741824,
                                "RulePriority": 0,
                                "CCType": 7,
                                "Field": "HEADER:User-Agent",
                                "CountTime": 60,
                                "EffectTime": 180,
                                "AccurateGroup": {
                                    "Id": 56697,
                                    "AccurateGroupPriority": 1073741824,
                                    "Logic": 2,
                                    "AccurateRules": [
                                        {
                                            "HttpObj": "request.method",
                                            "ObjType": 2,
                                            "Property": 0,
                                            "Opretar": 2,
                                            "ValueString": "GET"
                                        },
                                        {
                                            "HttpObj": "request.method",
                                            "ObjType": 2,
                                            "Property": 0,
                                            "Opretar": 2,
                                            "ValueString": "POST"
                                        }
                                    ]
                                },
                                "RuleTag": "E000000144566",
                                "UpdateTime": "2023-10-09T19:50:52+08:00"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}