DescribeTags-阿里云帮助中心

Queries a list of tags that meet the specified filter conditions.

Operation description

Specify at least ResourceId.N or Tag.N (Tag.N.Key and Tag.N.Value) in the request to determine the objects to query.
Tag.N is a tag of a resource and consists of a key-value pair. If you specify only Tag.N.Key, all tag values associated with the tag key are returned. If you specify only Tag.N.Value, an error is returned.
If you specify both Tag.N and ResourceId.N to filter tags, ResourceId.N must match any of the specified tag key-value pairs.
If you specify multiple tag key-value pairs, the results contain all tags that match any of the tag key-value pairs.

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

vpc:DescribeTags

get

*All Resource

*

vpc:tag

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The resource type. Valid values: VPC: virtual private cloud (VPC) instance. VSWITCH: virtual switch instance. ROUTETABLE: route table instance. EIP: elastic IP address (EIP) instance. VPNGATEWAY: VPN gateway instance. NATGATEWAY: NAT gateway instance. COMMONBANDWIDTHPACKAGE: Internet Shared Bandwidth instance. PREFIXLIST: prefix list instance. PUBLICIPADDRESSPOOL: IP address pool instance. IPV4GATEWAY: IPv4 gateway instance. IPV6GATEWAY: IPv6 gateway instance. NETWORKACL: network ACL instance. TRAFFICMIRRORFILTER: traffic mirror filter instance. TRAFFICMIRRORSESSION: traffic mirror session instance. FLOWLOG: flow log instance. HAVIP: high-availability virtual IP address instance. DHCPOPTIONSSET: DHCP options set instance. GATEWAYENDPOINT: gateway endpoint instance. Note The resource type value is case-insensitive.	VPC
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
NextToken	string	No	The pagination token. Valid values: If this is the first query or no subsequent query exists, leave this parameter empty. If a subsequent query exists, set this parameter to the NextToken value returned by the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResult	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 50.	50
ResourceId	array	No	The resource ID. You can specify up to 50 resource IDs.
	string	No	The resource ID. You can specify up to 50 resource IDs. Note When you specify this parameter, you must also specify the ResourceType parameter.	vpc-bp16qjewdsunr41m1****
Tag	array<object>	No	The tags of the resource.
	object	No	The tags of the resource.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. A tag key can be up to 128 characters in length. It cannot be an empty string or start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. A tag value can be up to 128 characters in length. It can be an empty string but cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	object
NextToken	string	The pagination token. Valid values: If NextToken is empty, no subsequent query exists. If NextToken is returned, the value indicates the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	C46FF5A8-C5F0-4024-8262-B16B639225A0
TagResources	object
TagResource	array<object>	The list of all tags that meet the filter conditions.
	object	The tag list.
TagValue	string	The tag value.	FinanceJoshua
TagKey	string	The tag key.	FinanceDept

Examples

Success response

JSON format

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	The tags and resource groups cannot be empty at the same time.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The TagKey parameter is not set.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The TagValue parameter is not set.
400	InvalidTagKey	The tag keys are not valid.	The tag index is invalid.
400	InvalidTagValue	The tag values are not valid.	The tag value is invalid.
400	MissingParam	%s
400	InvalidInstanceType.NotFound	The instance type is not found	The instance type is not found.
400	InvalidInstanceIds.NotFound	The instanceIds are not found	The instance ID is not found.
400	Forbidden.TagKeys	The request do not allow to operate the tag keys	You do not have the permissions to set the TagKeys parameter.
400	QuotaExceeded.TagNum	Custom Tags quota exceeded	The upper limit is reached.
400	Forbidden.NotAllowedCategary	The System tag is not valid	The error message returned because the system tag is invalid.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The number of tags has reached the upper limit.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.	The number of resource group IDs has reached the upper limit.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.