ListTagResources - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the tags that are added to resources.

Operation description

Usage notes

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 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, resources that contain these key-value pairs are returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListTagResources	get	All Resources *	vpc:tag	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Valid values: VPC VSWITCH ROUTETABLE EIP VpnGateway NATGATEWAY COMMONBANDWIDTHPACKAGE: EIP bandwidth plan	VPC
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values:1 to 50. Default value: 50.	50
ResourceId	array	No	The resource ID. You can specify up to 20 resource IDs.
	string	No	The resource ID. You can specify up to 20 resource IDs. Note You must specify at least one of ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value).	vpc-bp16qjewdsunr41m1****
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Tag	array<object>	No	The tag value. You can specify up to 20 tag values. It can be an empty string. The value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter but cannot start with `aliyun` or `acs:`. The value cannot contain `http://` or `https://`. Note You must specify at least one of ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value).	ListTagResources
	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 can be up to 64 characters in length and can contain letters, 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://`. Note Specify at least one of the ResourceId.N and Tag.N parameters (Tag.N.Key and Tag.N.Value).	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 value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter but cannot start with `aliyun` or `acs:`. The value cannot contain `http://` or `https://`. Note Specify at least one of the ResourceId.N and Tag.N parameters (Tag.N.Key and Tag.N.Value).	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If no value is returned for NextToken, no next queries are sent. If a value is returned for NextToken, the value is used to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	DE65F6B7-7566-4802-9007-96F2494AC512
TagResources	array<object>	The tag key.
	object
ResourceType	string	The type of the resource. Valid values: VPC: virtual private cloud (VPC) VSWITCH: vSwitch ROUTETABLE: route table EIP: EIP VpnGateWay: VPN gateway NATGATEWAY: NAT gateway COMMONBANDWIDTHPACKAGE: EIP bandwidth plan	VPC
TagValue	string	The tag value.	FinanceJoshua
ResourceId	string	The ID of the resource.	vpc-bp16qjewdsunr41m1****
TagKey	string	The tag key.	FinanceDept

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "VPC",
        "TagValue": "FinanceJoshua",
        "ResourceId": "vpc-bp16qjewdsunr41m1****",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.
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	MissingParam.ResourceType	The param of ResourceType is missing.	ResourceType is not specified.
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.

Change history

Change time	Summary of changes	Operation
2023-07-28	The Error code has changed	View Change Details
2023-07-10	The Error code has changed	View Change Details