查询指定域名下的 bot 频率限制或统计防护规则详情。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListBotAnalyseProtectRule | 要执行的操作,取值:ListBotAnalyseProtectRule。 |
Version | String | 是 | 2023-12-25 | API的版本,取值:2023-12-25。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Page | Integer | 否 | 1 | 页数 |
PageSize | Integer | 否 | 10 | 每页包含的条数 |
Host | String | 是 | abc.com | 域名 |
BotSpace | String | 是 | BotFrequency | Bot 防护规则类型:
|
RuleTag | String | 否 | R000000000629 | 规则标识,用于精确匹配。 |
Path | String | 否 | /path | 防护路径,用于模糊匹配。 |
Name | String | 否 | rule1 | 规则名称,用于模糊匹配。 |
Region | String | 是 | cn-beijing | 实例所在地域。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CurrentPage | Integer | 1 | 当前页码。 |
Data | Array of Object | -- | Bot 规则详情。 |
PageSize | Integer | 10 | 每页包含的条目数量上限。 |
TotalCount | Integer | 15 | 符合查询条件的条目总数。 |
Count | Integer | 5 | 当前页面显示的条目数量。 |
POST /?Action=ListBotAnalyseProtectRule&Version=2023-12-25 HTTP/1.1 Host: open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240603T110951Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240603/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "Page": 1, "PageSize": 10, "Host": "abc.com", "BotSpace": "BotFrequency", "RuleTag": "R000000000629", "Path": "/path", "Name": "rule1", "Region": "cn-beijing" }
{ "ResponseMetadata": { "RequestId": "202405292337262510621530803B****", "Action": "ListBotAnalyseProtectRule", "Version": "2023-12-25", "Service": "waf", "Region": "cn-beijing" }, "Result": { "Data": [ { "Group": { "Id": 12979, "AccurateGroupPriority": 99999999, "Logic": 1, "AccurateRules": [ { "ValueString": "Get", "Opretar": 2, "ObjType": 2, "HttpObj": "request.schema", "Property": 0 } ] }, "Rules": [ { "StatisticalType": 1, "StatisticalDuration": 10, "SingleThreshold": 100, "SingleProportion": "0.25", "RulePriority": 0, "Path": "/path", "Name": "name", "Host": "test.com", "Field": "HEADER:User-Agent", "ExemptionTime": 60, "Enable": 1, "EffectTime": 50, "ActionType": 6, "ActionAfterVerification": 1, "PathThreshold": 1000, "Id": 1234, "UpdateTime": "2024-05-29T21:20:17+08:00", "RuleTag": "R000000001234", "PassRatio": 0.13, "AccurateGroupPriority": 9999999, "AccurateGroup": { "Id": 12979, "AccurateGroupPriority": 99999999, "Logic": 1, "AccurateRules": [ { "ValueString": "Get", "Opretar": 2, "ObjType": 2, "HttpObj": "request.schema", "Property": 0 } ] } } ] } ] } }
您可访问公共错误码,获取更多错误码信息。