ListTagResources - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries tags based on the region ID and resource type.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
esa:ListTagResources	list	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the resources reside.	cn-hangzhou
ResourceId	array	No	The website ID.
	string	No	The website ID. The number of supported website IDs. Valid values: 1 to 50.	123456xxxxx
Tag	array<object>	No	A list of tags. You can enter up to 20 tags.
	object	No	A list of tags. You can enter up to 20 tags.
Key	string	No	The tag key.	env
Value	string	No	The tag value.	value
ResourceType	string	Yes	The resource type.	site
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Note This parameter is not required for the first request. If not all results are returned in one query, you can specify the token that is obtained from the previous query as the value of NextToken.	AAAAAZjtYxxxxxxxx
MaxItem	integer	No	The maximum number of tags to return.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAYwsxxxxxxx
TagResources	array<object>	The tags of the resource.
TagResource	object	The tags of the resource.
TagKey	string	The tag key.	env
TagValue	string	The tag value.	value
ResourceId	string	The resource ID.	example.com
ResourceType	string	The resource type.	site
TotalCount	integer	The total number of entries returned.	16

Examples

Sample success responses

JSONformat

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "NextToken": "AAAAAYwsxxxxxxx",
  "TagResources": [
    {
      "TagKey": "env",
      "TagValue": "value",
      "ResourceId": "example.com",
      "ResourceType": "site"
    }
  ],
  "TotalCount": 16
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.TagValue	The specified TagValue is invalid.	The TagValue parameter is invalid.
404	InvalidResourceId.NotFound	The specified resource does not exist or is released.	The resource does not exist or has been released.

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

Change history

Change time	Summary of changes	Operation
2024-09-18	The Error code has changed	View Change Details