Bot Management Rule Label Types in WAF - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the tag information 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeBotRuleLabels

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of your WAF instance.	waf_v3prepaid_public_cn-53y4******
SubScene	string	No	The type of bot management protection scenario. Valid values: app : App protection scenario. web : Web protection scenario.	app
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
LabelType	string	No	The type of bot rule tag to query.	human_machine_challenge
NextToken	string	No	The pagination token for the next page. If a value is returned for this parameter, the next page exists. Note If this parameter has a return value, the next page exists. Use the returned NextToken value as a request parameter to retrieve the next page of data. Repeat until no value is returned, which indicates that all data has been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	No	The number of entries per page in a paged query. Valid values: 1 to 200. Default value: 20. This parameter is used for paging.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19****5EB0
RuleLabels	array<object>	The list of bot management rule tags.
	object
LabelKey	string	The bot management rule tag.	malicious_crawler_python
SubScene	string	The set of bot management protection scenarios to which the rule belongs. Multiple scenarios are separated by commas (,). Valid values: web: Web protection scenario. app: App protection scenario.	web,app
BotBehavior	string	The crawler behavior corresponding to the rule tag. malicious: malicious crawler. suspicious: suspected crawler. normal: normal crawler.	malicious
LabelType	string	The type of the bot rule tag.	human_machine_challenge
DefaultStatus	integer	The default status of the tag rule. 1: The rule is enabled. 0: The rule is disabled.	1
DefaultAction	string	The default action. Valid values: block: Block. monitor: Monitor. js: JavaScript verification. captcha: slider CAPTCHA. captcha_strict: strict slider CAPTCHA. bypass: Allow.	block
DefaultConfig	string	The default configurations corresponding to the label.	{"crawlerStatusMap":{"360":1,"bytedance":1}}
LabelStatus	string	The tag status. online: Online. wait_offline: Pending offline.	online
NextToken	string	The pagination token for the next page. If a value is returned for this parameter, the next page exists. Note If this parameter has a return value, the next page exists. Use the returned NextToken value as a request parameter to retrieve the next page of data. Repeat until no value is returned, which indicates that all data has been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The number of entries per page in a paged query. Valid values: 1 to 200. Default value: 20. This parameter is used for paging.	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",
      "DefaultStatus": 1,
      "DefaultAction": "block",
      "DefaultConfig": "{\"crawlerStatusMap\":{\"360\":1,\"bytedance\":1}}",
      "LabelStatus": "online"
    }
  ],
  "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.