All Products
Search

This Product

    Web Application Firewall:DescribeBotRuleLabels

    Document Center

    Web Application Firewall:DescribeBotRuleLabels

    Last Updated:Jan 05, 2026

    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

    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

    The ID of the WAF instance.

    Note

    Call the DescribeInstance operation to query the ID of your WAF instance.

    waf_v3prepaid_public_cn-53y4******
    SubScene

    string

    No

    The type of bot management scenario. Valid values:

    • web: web protection.

    • app: app protection.

    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 bot rule label to query.

    human_machine_challenge
    NextToken

    string

    No

    The token to retrieve the next page of results. This parameter is returned if a next page exists.

    Note

    If a value is returned for this parameter, it indicates that more results are available. Use the returned NextToken value in the next request to retrieve the next page of results. Repeat this process until no value is returned for this parameter. This indicates that all results have been retrieved.

    AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    MaxResults

    integer

    No

    The number of entries to return on each page. 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>

    The list of bot management rule labels.

    object

    LabelKey

    string

    The bot management rule label.

    malicious_crawler_python
    SubScene

    string

    The bot management scenarios to which the rule belongs. Multiple scenarios are separated by commas (,). Valid values:

    • web: web protection.

    • app: app protection.

    Web,app
    BotBehavior

    string

    The bot behavior that corresponds to the rule label.

    • malicious: malicious bot.

    • suspicious: suspected bot.

    • normal: normal bot.

    malicious
    LabelType

    string

    The type of the bot rule label.

    human_machine_challenge
    NextToken

    string

    The token to retrieve the next page of results. This parameter is returned if a next page exists.

    Note

    If a value is returned for this parameter, it indicates that more results are available. Use the returned NextToken value in the next request to retrieve the next page of results. Repeat this process until no value is returned for this parameter. This indicates that all results have been retrieved.

    AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    MaxResults

    integer

    The number of entries to return on each page. Valid values: 1 to 200. Default value: 20.

    20
    TotalCount

    integer

    The total number of results.

    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.