DescribeTags - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries tags that meet the specified filter conditions.

Operation description

You must specify ResourceId.N or Tag.N that consists of Tag.N.Key and Tag.N.Value in the request to specify the object that you want to query.
Tag.N is a resource tag that consists of a key-value pair. If you specify only Tag.N.Key, all tag values that are associated with the specified tag key are returned. If you specify only Tag.N.Value, an error message is returned.
If you specify Tag.N and ResourceId.N to filter tags, ResourceId.N must match all specified key-value pairs.
If you specify multiple key-value pairs, all tags that match the key-value pairs are returned.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeTags	get	All Resources *	vpc:tag	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The resource type. Valid values: VPC: virtual private cloud (VPC) VSWITCH: vSwitch ROUTETABLE: route table EIP: elastic IP address (EIP) VpnGateway: VPN gateway NATGATEWAY: NAT gateway COMMONBANDWIDTHPACKAGE: EIP bandwidth plan	VPC
RegionId	string	Yes	The ID of the region to which the resource belongs. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
NextToken	string	No	The token that is used for the next query. Valid values: If this is your first query or no next query is to be sent, ignore this parameter. If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResult	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.	50
ResourceId	array	No
	string	No	The ID of the resource. You can enter at most 50 IDs. Note If you set this parameter, you must set ResourceType.	vpc-bp16qjewdsunr41m1****
Tag	array<object>	No
	object	No
Key	string	No	The key of the tag that is added to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The key cannot exceed 64 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The value of the tag that is added to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.	FinanceJoshua

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.TagKeys	The request does not allow operate this tagkeys	The error message returned because you cannot manage the tag key by calling the operation.
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.

For a list of error codes, visit the Service error codes.