ListTagResources - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries resources by tag.

Operation description

To specify the objects to retrieve, your request must contain at least one of the following parameters: ResourceId.N or Tag.N (which consists of Tag.N.Key and Tag.N.Value).
Tag.N is a resource tag that consists of a key-value pair. If you specify only Tag.N.Key, all tag values associated with that tag key are returned. An error occurs if you specify only Tag.N.Value.
If you specify both Tag.N and ResourceId.N to filter resources, only the resources that are specified by ResourceId.N and match all the specified tag key-value pairs are returned.
If you specify multiple tag key-value pairs, only the resources that have all the specified key-value pairs are returned.

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

alidns:ListTagResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	en
ResourceType	string	Yes	The resource type. Valid value: DOMAIN: domain name	DOMAIN
NextToken	string	No	The token used to start the next query.	4698691
Tag	array<object>	No	An array of tag key-value pairs.
	object	No
Key	string	No	The tag key.	abcd
Value	string	No	The tag value.	abcd
ResourceId	array	No	The resource ID.
	string	No	The domain name. This parameter is required if the Tag array is empty.	example.com

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token to start the next query. An empty value indicates that there are no more results.	4698691
RequestId	string	The unique ID of the request.	61092C8D-6AEB-4310-B74D-C632F89BF4FB
TagResources	array<object>	A collection of resources and their tags. It includes information such as the resource ID, resource type, tag key, and tag value.
	object
ResourceType	string	The resource type. The value is DOMAIN.	DOMAIN
TagValue	string	The tag value.	abcd
ResourceId	string	The resource ID.	example.com
TagKey	string	The tag key.	abcd

Examples

Success response

JSON format

{
  "NextToken": "4698691",
  "RequestId": "61092C8D-6AEB-4310-B74D-C632F89BF4FB",
  "TagResources": [
    {
      "ResourceType": "DOMAIN",
      "TagValue": "abcd",
      "ResourceId": "example.com",
      "TagKey": "abcd"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.