Web Application Firewall
Web Application Firewall
Document
- Documentation
Web Application FirewallAPI referenceBot managementListBotAnalyseProtectRulePriorityAvailable
Copy page
Download PDFBot management
ListBotAnalyseProtectRulePriorityAvailable
Copy pageDownload PDFListBotAnalyseProtectRulePriorityAvailable
When creating a bot statistics protection rule, you need to set the rule's priority, and the priority cannot be duplicated. You can call the ListBotAnalyseProtectRulePriorityAvailable interface to query the available priorities for bot statistics rules.
HTTP request
- Method: POST
- URL: https://waf.volcengineapi.com/?Action=ListBotAnalyseProtectRulePriorityAvailable&Version=2023-12-25
Request parameters
Only the request parameters unique to this interface and some common parameters are listed below. For more information, please see common parameters.
Query
Action string required Sample value: ListBotAnalyseProtectRulePriorityAvailable
The action to be performed, the value is: ListBotAnalyseProtectRulePriorityAvailable.
Version string required Example value: 2023-12-25
The version of the API, value: 2023-12-25.
Body
Path string required Example value: /path
Request path.
ProjectName string optional Sample value: default
The resource name of the project, the acquisition method can refer to ListDomain - Query Cloud WAF instance protection website information.
Host string required Example value: example.volc001.com
Domain name.
BotSpace string required Sample value: BotFrequency
Bot protection rule type:
- BotFrequency: rate limiting rule. The corresponding statistical content method is access frequency.
- BotRepeat: Statistics protection rules. The corresponding statistical content methods are repeat count or repeat ratio.
PageSize integer Optional Example value: 10
The maximum number of items displayed per page.
Page integer Optional Sample value: 1
The page number of the current page.
Response parameters
Only the unique response parameters of this interface are listed below. For more information, please refer to Return structure.
RulePriority integer[] Example values: [7,8,9]
Available priorities, sorted in ascending order. 0 represents P0, which is the highest priority.
Sample request
POST /?Action=ListBotAnalyseProtectRulePriorityAvailable&Version=2023-12-25 HTTP/1.1
Host: waf.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250328T124919Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250328/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"Path": "/path",
"ProjectName": "default",
"Host": "example.volc001.com",
"BotSpace": "BotFrequency",
"PageSize": 10,
"Page": 1
}
Sample response
{
"ResponseMetadata": {
"RequestId": "20240603175107147008234239907D07",
"Version": "2023-12-25",
"Service": "waf",
"Region": "cn-beijing"
},
"Result": {
"RulePriority": [
7,
8,
9
]
}
}
Error codes
Last updated: 2025.06.30 16:25:33
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
