DescribeBotRuleLabels - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the labels of bot management rules.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call the DescribeInstance operation to query the ID of your WAF instance.	waf_v3prepaid_public_cn-53y4******
SubScene	string	No	The type of the bot management protection scenario. Valid values: web: web protection scenarios. app: app protection scenarios.	app
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
LabelType	string	No	The type of the bot rule label to query.	human_machine_challenge
NextToken	string	No	The token that is used to retrieve the next page of results. If a value is returned for this parameter, it indicates that more results are available. Note If this parameter is returned, more results are available. To retrieve the next page of results, include the returned NextToken value in your next request. Repeat this process until this parameter is not returned. This indicates that all results have been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	No	The number of entries to return on each page for a paged query. Valid values: 1 to 200. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19****5EB0
RuleLabels	array<object>	A list of bot management rule labels.
	object
LabelKey	string	The bot management rule label.	malicious_crawler_python
SubScene	string	The bot management protection scenarios to which the rule belongs. Multiple scenarios are separated by commas (,). Valid values: web: web protection scenarios. app: app protection scenarios.	Web,app
BotBehavior	string	The bot behavior that corresponds to the rule label. malicious: malicious crawlers. suspicious: suspicious crawlers. normal: normal crawlers.	malicious
LabelType	string	The type of the bot rule label.	human_machine_challenge
NextToken	string	The token that is used to retrieve the next page of results. If a value is returned for this parameter, it indicates that more results are available. Note If this parameter is returned, more results are available. To retrieve the next page of results, include the returned NextToken value in your next request. Repeat this process until this parameter is not returned. This indicates that all results have been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The number of entries returned on each page. Valid values: 1 to 200. Default value: 20.	20
TotalCount	integer	The total number of entries returned.	8

Examples

Success response

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0",
  "RuleLabels": [
    {
      "LabelKey": "malicious_crawler_python",
      "SubScene": "Web,app",
      "BotBehavior": "malicious",
      "LabelType": "human_machine_challenge"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 20,
  "TotalCount": 8
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.