Query WAF Template Resources with DescribeTemplateResources API - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the resources bound to a 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:DescribeTemplateResources

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of the current WAF instance.	waf_cdnsdf3****
TemplateId	integer	Yes	The ID of the protection template.	1020
ResourceType	string	Yes	The type of the protected resource. Valid values: single: protected object. asset: protected asset. group: protected object group. Valid values: single : Protected object. asset : Protected asset. group : Protected object group.	single
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 Alibaba Cloud resource group.	rg-acfm***q
NextToken	string	No	The pagination token (Token) for the next page. Set this parameter to the value of NextToken returned in the previous API call. Leave this parameter empty for the first page.	AAAAAJ7ob7*******MhJJ1ELRE=
MaxResults	integer	No	The number of entries per page in a paged query. Valid values: 1 to 500. Default value: 500.	20
Resource	string	No	The name of the protected object or protected object group to fuzzy match.	abc.test.com-waf
AssetApi	string	No	The API of the protected asset to fuzzy match.	abc.com

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	C7BC9373-3960-53B0-8968-2B13454AE18F
Resources	array	The list of bound protected object names, protected object group names, or protected asset IDs.
	string	The name of the protected object, the name of the protected object group, or the ID of the protected asset.	alb-wewbb23dfset***
TotalCount	integer	The total number of entries returned.	25
NextToken	string	The pagination token (Token) for the next page. If a next page exists, this field contains a value. Note If this parameter has a return value, a next page exists. Use the returned NextToken as a request parameter to retrieve the next page of data. Repeat until no value is returned, which indicates that all data has been retrieved.	AAAAABLQv******37sHZaHk4=
MaxResults	integer	The number of entries per page in a paged query. Valid values: 1 to 500. Default value: 500.	20
TemplateId	integer	The ID of the protection template.	168465

Examples

Success response

JSON format

{
  "RequestId": "C7BC9373-3960-53B0-8968-2B13454AE18F",
  "Resources": [
    "alb-wewbb23dfset***"
  ],
  "TotalCount": 25,
  "NextToken": "AAAAABLQv******37sHZaHk4=",
  "MaxResults": 20,
  "TemplateId": 168465
}

Error codes

HTTP status code	Error code	Error message	Description
400	Defense.Control.DefenseTemplateNotExist	The protection template does not exist.	The protection template does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.