Web应用防火墙
Web应用防火墙
文档指南
请输入
- 文档首页
Web应用防火墙API 参考Bot 管理ListBotAnalyseProtectRulePriorityAvailable - 查询 bot 防护规则可用优先级
复制全文
下载 pdfListBotAnalyseProtectRulePriorityAvailable - 查询 bot 防护规则可用优先级
文档反馈
问问助手创建 bot 统计防护规则时，需要设置规则的优先级，且优先级不可重复。您可以调用 ListBotAnalyseProtectRulePriorityAvailable 接口查询 bot 统计规则可用的优先级。
注意事项
- 服务接口调用总上限：1000 QPS
- 单账号调用上限：50 QPS
请求说明
- 请求方式：POST
- 请求地址：https://waf.volcengineapi.com/?Action=ListBotAnalyseProtectRulePriorityAvailable&Version=2023-12-25
请求参数
Query
Action String 必选 示例值：ListBotAnalyseProtectRulePriorityAvailable
接口名称。当前 API 的名称为 ListBotAnalyseProtectRulePriorityAvailable。
Version String 必选 示例值：2023-12-25
接口版本。当前 API 的版本为 2023-12-25。
Body
Path String 必选 示例值：/path
请求路径。
ProjectName String 可选 示例值：default
Host String 必选 示例值：example.volc001.com
域名信息。
BotSpace String 必选 示例值：BotFrequency
Bot 防护规则类型：
- BotFrequency：频率限制规则。对应统计内容方式为访问频率。
- BotRepeat：统计防护规则。对应统计内容方式为重复次数或重复占比。
PageSize Integer 可选 示例值：10
每页包含的条目数量上限。
Page Integer 可选 示例值：1
当前页码。
AccurateGroup Object 可选 示例值：-
指定查询的高级条件分组，传入时表示查询该路径下指定高级条件分组内的可用规则优先级；不传时表示查询该路径下默认分组的可用规则优先级。仅当AccurateGroup校验通过且存在有效AccurateRules时才会传入。
AccurateGroupPriority Integer 可选 示例值：10000000
高级条件分组实际对应的优先级，创建规则时无需携带该字段，仅在列表展示高级条件分组时返回该值。
Id Integer 可选 示例值：167913
高级条件分组对应的 ID，创建规则时无需携带该字段，仅在列表展示高级条件分组时用于聚合展示。
Logic Integer 必选 示例值：1
- 1：与（AND）；
- 2：或（OR）。
AccurateRules Object[] 必选 示例值：--
高级条件中的子规则列表。
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时，无需填写该字段；其余操作符场景均需按实际匹配值填写。
返回参数
RulePriority Integer[] 示例值：[7,8,9]
可用的优先级，按升序排列。0 表示 P0，即最高优先级。
TotalCount Integer 示例值：1
总数据数量。
PageSize Integer 示例值：1
一页包含的数据数量。
CurrentPage Integer 示例值：1
当前页数。
Count Integer 示例值：1
当前页返回的数据数量。
错误码
输入示例 1
输入示例 2
输入示例
POST https://waf.volcengineapi.com/?Action=ListBotAnalyseProtectRulePriorityAvailable&Version=2023-12-25&ProjectName=default
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=<AccessKeyId>/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=<Signature>
{
"Host": "wafexample.com",
"Path": "/login",
"BotSpace": "BotFrequency",
"AccurateGroup": {
"Logic": 1,
"AccurateRules": [
{
"HttpObj": "request.cookie.token",
"ObjType": 15,
"Property": 0,
"Opretar": 2,
"ValueString": "token-123456"
}
]
}
}输出示例
{
"ResponseMetadata": {
"RequestId": "2026052611350902B2E106B99E273BD211",
"Action": "ListBotAnalyseProtectRulePriorityAvailable",
"Version": "2023-12-25",
"Service": "waf",
"Region": "cn-beijing"
},
"Result": {
"RulePriority": [0, 1, 2, 3]
}
}最近更新时间：2026.06.03 17:05:17
这个页面对您有帮助吗？
有用
有用
无用
无用