DescribeDefenseTemplates - Web Application Firewall - Alibaba Cloud Documentation Center

Performs a paging query to retrieve protection templates.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeDefenseTemplates	list	All Resources ``	none	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 query the ID of the WAF instance.	waf_v3prepaid_public_cn-pe33b****03
TemplateId	long	No	The ID of the protection template.	12345
TemplateType	string	No	The type of the protection template. Valid values: user_default: default template. user_custom: custom template.	user_default
DefenseScene	string	No	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.	region_block
Resource	string	No	The name of the protected object or protected object group. Note If you specify ResourceType, you must specify this parameter.	xxxqiu.cc-ecs
ResourceType	string	No	The type of the protected resource. Valid values: single: protected object. This is the default value. group: protected object group. Note If you specify Resource, you must specify this parameter.	single
DefenseSubScene	string	No	The sub-scenario in which the protection template is used. Valid values: web: bot management for website protection. app: bot management for app protection. basic: bot management for basic protection.	basic
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	10
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfmvyknl****fa
RegionId	string	No	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

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	4F26D2F1-E288-5104-8518-05E240E3****
TotalCount	long	The total number of entries returned.	100
Templates	array<object>	The protection templates.
Template	object
DefenseScene	string	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
GmtModified	long	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.	1683776070000
TemplateId	long	The ID of the protection template.	12345
TemplateName	string	The name of the protection template.	testTemplateName
TemplateOrigin	string	The origin of the protection template. The value custom indicates that the protection template is a custom template created by the user.	custom
TemplateStatus	integer	The status of the protection template. Valid values: 0: disabled. 1: enabled.	1
TemplateType	string	The type of the protection template. Valid values: user_default: default template. user_custom: custom template.	user_custom
DefenseSubScene	string	The sub-scenario in which the protection template is used. Valid values: web: bot management for website protection. app: bot management for app protection. basic: bot management for basic protection.	basic
Description	string	The description of the protection template.	test

Examples

Sample success responses

JSONformat

{
  "RequestId": "4F26D2F1-E288-5104-8518-05E240E3****",
  "TotalCount": 100,
  "Templates": [
    {
      "DefenseScene": "whitelist",
      "GmtModified": 1683776070000,
      "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.