All Products
Search

This Product

    Web Application Firewall:DescribeDefenseResourceTemplates

    Document Center

    Web Application Firewall:DescribeDefenseResourceTemplates

    Last Updated:Sep 13, 2024

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

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-waf:DescribeDefenseResourceTemplateslist
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

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

    Note You can call the DescribeInstance operation to query the ID of the WAF instance.
    		waf_v3prepaid_public_cn-9lb36****0e
    ResourcestringYes

    The name of the protected object or protected object group that you want to query.

    		xxxxxhemicals.cn-waf
    ResourceTypestringNo

    The type of the protected resource. Valid values:

    • single: protected object. This is the default value.
    • group: protected object group.
    		single
    RuleTypestringNo

    The type of the protection rule. Valid values:

    • defense: defense rule. This is the default value.
    • whitelist: whitelist rule.
    		whitelist
    RuleIdlongNo

    The ID of the protection rule.

    		20111098
    ResourceManagerResourceGroupIdstringNo

    The ID of the Alibaba Cloud resource group.

    		rg-aek2ax2y5****pi
    RegionIdstringNo

    The region in which the WAF instance is deployed. Valid values:

    • cn-hangzhou: Chinese mainland.
    • ap-southeast-1: outside the Chinese mainland.
    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		2305CEB0-BA5A-5543-A1D3-3F1D0891****
    Templatesarray<object>

    The protection templates.

    object
    DefenseScenestring

    The scenario in which the protection template is used.

    • waf_group: basic protection.
    • antiscan: scan protection.
    • ip_blacklist: IP address blacklist.
    • custom_acl: custom rule.
    • whitelist: whitelist.
    • region_block: region blacklist.
    • custom_response: custom response.
    • cc: HTTP flood protection.
    • tamperproof: website tamper-proofing.
    • dlp: data leakage prevention.
    		whitelist
    GmtModifiedlong

    The time when the protection template was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    		1692930539000
    TemplateIdlong

    The ID of the protection template.

    		12345
    TemplateNamestring

    The name of the protection template.

    		TestTemplateName
    TemplateOriginstring

    The origin of the protection template. The value custom indicates that the template is a custom template created by the user.

    		custom
    TemplateStatusinteger

    The status of the protection template. Valid values:

    • 0: disabled.
    • 1: enabled.
    		1
    TemplateTypestring

    The type of the protection template. Valid values:

    • user_default: default template.
    • user_custom: custom template.
    		user_custom
    DefenseSubScenestring

    The sub-scenario in which the template is used. Valid values:

    • web: bot management for website protection.
    • app: bot management for app protection.
    • basic: bot management for basic protection.
    		basic
    Descriptionstring

    The description of the protection template.

    		test

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "2305CEB0-BA5A-5543-A1D3-3F1D0891****",
  "Templates": [
    {
      "DefenseScene": "whitelist",
      "GmtModified": 1692930539000,
      "TemplateId": 12345,
      "TemplateName": "TestTemplateName",
      "TemplateOrigin": "custom",
      "TemplateStatus": 1,
      "TemplateType": "user_custom",
      "DefenseSubScene": "basic",
      "Description": "test"
    }
  ]
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history