All Products
Search

This Product

    Web Application Firewall:DescribeDefenseResourceTemplates

    Document Center

    Web Application Firewall:DescribeDefenseResourceTemplates

    Last Updated:Mar 22, 2026

    Queries the protection templates associated with a protected object or protected object group.

    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:DescribeDefenseResourceTemplates

    list

    *All Resource

    *

    • acs:ResourceGroupId

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    InstanceId

    string

    Yes

    The ID of the Web Application Firewall (WAF) instance.

    Note

    Call DescribeInstance to obtain the instance ID.

    waf_v3prepaid_public_cn-9lb36****0e

    Resource

    string

    Yes

    The name of the protected object or protected object group, or the ID of the protected asset to query.

    mitsuichemicals.cn-waf

    ResourceType

    string

    No

    The type of protected resource. Valid values:

    • single (default): A protected object.

    • group: A protected object group.

    • asset: A protected asset.

    single

    RuleType

    string

    No

    The type of protection rule. Valid values:

    • defense (default): A protection rule.

    • whitelist: A whitelist rule.

    whitelist

    RuleId

    integer

    No

    The ID of the protection rule.

    20111098

    RuleName

    string

    No

    The name of the protection rule.

    demoRuleName

    TemplateName

    string

    No

    The name of the protection template to query.

    test221

    RegionId

    string

    No

    The region of the WAF instance. Valid values:

    • cn-hangzhou: the Chinese mainland

    • ap-southeast-1: outside the Chinese mainland

    cn-hangzhou

    ResourceManagerResourceGroupId

    string

    No

    The ID of the Alibaba Cloud resource group.

    rg-aek2ax2y5****pi

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    2305CEB0-BA5A-5543-A1D3-3F1D08911B1C

    Templates

    array<object>

    The protection templates.

    object

    The protection template.

    Description

    string

    The description of the template.

    testTemplate

    TemplateOrigin

    string

    The origin of the protection template. The value custom indicates a user-created template.

    custom

    DefenseSubScene

    string

    The sub-scenario of the template. Valid values:

    • web: The bot management template for web protection.

    • app: The bot management template for app protection.

    • basic: The basic bot management template.

    basic

    DefenseScene

    string

    The protection scenario. For more information, see the DefenseScene parameter in CreateDefenseRule.

    whitelist

    GmtModified

    integer

    The time when the protection template was created, in UNIX timestamp format. Unit: milliseconds.

    1692930539000

    TemplateName

    string

    The name of the protection template.

    antiscanTemplate

    TemplateType

    string

    The type of the template. Valid values:

    • user_default: The default template for the user.

    • user_custom: A custom template created by the user.

    user_custom

    TemplateId

    integer

    The ID of the protection template.

    34328

    TemplateStatus

    integer

    The status of the protection template. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "2305CEB0-BA5A-5543-A1D3-3F1D08911B1C",
  "Templates": [
    {
      "Description": "testTemplate",
      "TemplateOrigin": "custom",
      "DefenseSubScene": "basic",
      "DefenseScene": "whitelist",
      "GmtModified": 1692930539000,
      "TemplateName": "antiscanTemplate",
      "TemplateType": "user_custom",
      "TemplateId": 34328,
      "TemplateStatus": 1
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.