ListTagResources - Query tags bound to VPC resources - Virtual Private Cloud

Queries tags bound to specified VPC resources.

Operation description

Usage notes

Specify at least ResourceId.N or Tag.N (Tag.N.Key and Tag.N.Value) in the request.
Tag.N is a key-value pair. If you specify only Tag.N.Key, all associated tag values are returned. If you specify only Tag.N.Value, an error is returned.
If you specify both Tag.N and ResourceId.N, ResourceId.N must match all specified key-value pairs.
If you specify multiple key-value pairs, only resources matching all pairs are returned.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 for the next page. Leave empty for the first request. For subsequent requests, use the NextToken value from the previous response.	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.	vpc-bp16qjewdsunr41m1****
	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. Call DescribeRegions to query available regions.	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 tag key. You can specify up to 20 tag keys. 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 tag value. You can specify up to 20 tag values. 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 elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token for the next page. If empty, no more results exist. If returned, pass this value as NextToken in the next request to retrieve more results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	DE65F6B7-7566-4802-9007-96F2494AC512
TagResources	object
TagResource	array<object>	The tag key.
	object
ResourceType	string	The resource type. Valid values: VPC VSWITCH ROUTETABLE EIP VpnGateWay: VPN gateway NATGATEWAY 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

Success response

JSON format

{
  "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.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.
403	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.