DescribeTags - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Operation description

Limits

You can query 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:DescribeTags

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
PageNumber	integer	No	The page number. The start value is 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	200
PageSize	integer	The number of entries returned per page.	20
RequestId	string	The unique request ID.	9EA7F720-B7C0-45C1-9CF4-B6A5A1179B68
PageNumber	integer	The returned page number.	1
Tags	array<object>	The list of resource tags.
	object	The information about the resource tag.
Key	string	The tag key of the resource.	env
Values	array	The list of tag values.
	string	The tag value.	daily

Examples

Success response

JSON format

{
  "TotalCount": 200,
  "PageSize": 20,
  "RequestId": "9EA7F720-B7C0-45C1-9CF4-B6A5A1179B68",
  "PageNumber": 1,
  "Tags": [
    {
      "Key": "env",
      "Values": [
        "daily"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.