Query ESA Site Tags with ListTagResources API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries tags by region ID and resource type.

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

esa:ListTagResources

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Valid values: Alibaba Cloud China Website (www.aliyun.com): cn-hangzhou Alibaba Cloud International Website (www.alibabacloud.com): ap-southeast-1.	cn-hangzhou
ResourceId	array	No	The resource ID. Enter a site ID or a DNS record ID. You must specify at least one of ResourceId and Tag.
	string	No	The resource ID. Enter a site ID or a DNS record ID.	123456xxxxx
Tag	array<object>	No	The list of tags. You can specify up to 20 tags. You must specify at least one of ResourceId and Tag.
	object	No	The list of tags. You can specify up to 20 tags.
Key	string	No	The tag key.	env
Value	string	No	The tag value.	value
ResourceType	string	Yes	The resource type. Valid values: site: site record: DNS record.	site
NextToken	string	No	The token for the next query to return more results. Note You do not need to specify this parameter for the first query. If a query does not return all results, pass the NextToken value returned from the previous query to continue the query.	AAAAAZjtYxxxxxxxx
MaxItem	integer	No	The maximum number of entries to return.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
NextToken	string	The token for the next query. If NextToken is empty, all information has been displayed on the current page.	AAAAAYwsxxxxxxx
TagResources	array<object>	The resource tags.
	object	The resource tags.
TagKey	string	The tag key.	env
TagValue	string	The tag value.	value
ResourceId	string	The resource ID. Enter a site ID or a DNS record ID.	example.com
ResourceType	string	The resource type. Valid values: site: site record: DNS record.	site
TotalCount	integer	The total number of entries.	1

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.