All Products
Search

This Product

    Web Application Firewall:DescribeDefenseTemplate

    Document Center

    Web Application Firewall:DescribeDefenseTemplate

    Last Updated:Mar 22, 2026

    Retrieves the details of a specific protection template.

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

    get

    *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

    You can call the DescribeInstance operation to obtain the ID of the WAF instance.

    waf_cdnsdf3****
    TemplateId

    integer

    Yes

    The ID of the protection template that you want to query.

    1333
    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
    ResourceManagerResourceGroupId

    string

    No

    The ID of the resource group.

    rg-acfm***q

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The ID of the request.

    D7861F61-5B61-46CE-A47C-6B19160D5EB0
    Template

    object

    The details of the protection template.

    Description

    string

    The description of the protection template.

    test
    TemplateOrigin

    string

    The origin of the protection template. A value of custom indicates that the template is user-defined.

    custom
    DefenseSubScene

    string

    The sub-scenario of the protection template. Valid values:

    • web: the bot management template for website protection.

    • app: the bot management template for app protection.

    • basic: the basic bot management template.

    • bot_custom_acl: the bot management template for custom protection rules.

    app
    DefenseScene

    string

    The scenario in which the protection template is used. For more information, see the description of the DefenseScene parameter in the CreateDefenseRule operation.

    waf_group
    GmtModified

    integer

    The most recent time the protection template was modified. This value is a UNIX timestamp. Unit: milliseconds.

    1665283642000
    TemplateName

    string

    The name of the protection template.

    test0621
    TemplateType

    string

    The type of the protection template. Valid values:

    • user_default: the default template.

    • user_custom: a custom template.

    user_default
    TemplateId

    integer

    The ID of the protection template.

    10097
    TemplateStatus

    integer

    The status of the protection template. Valid values:

    • 0: disabled.

    • 1: enabled.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Template": {
    "Description": "test",
    "TemplateOrigin": "custom",
    "DefenseSubScene": "app",
    "DefenseScene": "waf_group",
    "GmtModified": 1665283642000,
    "TemplateName": "test0621",
    "TemplateType": "user_default",
    "TemplateId": 10097,
    "TemplateStatus": 1
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.