ListTagResources - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the tags that are added to resources in Private Zone.

Operation description

Limits

This operation queries tags for zone resources only.

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

pvtz:ListTagResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English Default value: en.	en
ResourceType	string	Yes	The resource type. Set the value to ZONE.	ZONE
NextToken	string	No	The token that is used to start the next query. It is returned in the response to the previous query.	23423****
Size	integer	No	The number of entries to return on each page. Maximum value: 200. Default value: 20.	20
ResourceId	array	No	A list of resource IDs. In this case, a list of zone IDs. You can specify up to 50 IDs.	97fe9321a476d0861f624d3f738dcc38
	string	No	The resource ID. In this case, the zone ID.	97fe9321a476d0861f624d3f738d****
Tag	array<object>	No	A list of tags.
	object	No	The tag information.
Key	string	No	The key of the tag.	env
Value	string	No	The value of the tag.	daily

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token for the next query. If this parameter is empty, all results have been returned.	23423****
RequestId	string	The unique request ID.	75446CC1-FC9A-4595-8D96-089D73D7A63D
TagResources	array<object>	The list of tagged resources.
	object	The details of a tagged resource.
ResourceType	string	The resource type.	ZONE
TagValue	string	The tag value.	daily
ResourceId	string	The resource ID. In this case, the zone ID.	97fe9321a476d0861f624d3f738d****
TagKey	string	The tag key.	env

Examples

Success response

JSON format

{
  "NextToken": "23423****",
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "TagResources": [
    {
      "ResourceType": "ZONE",
      "TagValue": "daily",
      "ResourceId": "97fe9321a476d0861f624d3f738d****",
      "TagKey": "env"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.