DescribeDefenseResourceTemplates - Web Application Firewall

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 You can call DescribeInstance to view the ID of the current WAF instance.	waf_v3prepaid_public_cn-9lb36****0e
Resource	string	Yes	The name of the protected object or protected object group that you want to query.	mitsuichemicals.cn-waf
ResourceType	string	No	The type of the protected resource. Valid values: single (default): Protected object. group: Protected object group.	single
RuleType	string	No	The type of protection rule that you want to query. Valid values: defense (default): Protection rule. whitelist: 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 that you want 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.	示例防护模板
TemplateOrigin	string	The value custom indicates that the template is a custom template created by the user.	custom
DefenseSubScene	string	The sub-scenario in which the template is used. Valid values: web: The BOT management web protection scenario template. app: The BOT management APP protection scenario template. basic: The BOT management basic protection template.	basic
DefenseScene	string	The scenario in which the protection template is used. Valid values: waf_group: Basic protection. antiscan: Scan protection. ip_blacklist: IP blacklist. custom_acl: Custom rules. whitelist: Whitelist. region_block: Region blocking. custom_response: Custom response. cc: CC protection. tamperproof: Web tamper-proofing. dlp: Data leakage prevention.	whitelist
GmtModified	integer	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
TemplateName	string	The name of the protection template.	WAF扫描防护
TemplateType	string	The type of the protection template. Valid values: user_default: Default user protection. user_custom: Custom user protection.	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": "示例防护模板",
      "TemplateOrigin": "custom",
      "DefenseSubScene": "basic",
      "DefenseScene": "whitelist",
      "GmtModified": 1692930539000,
      "TemplateName": "WAF扫描防护",
      "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.