ListTagResources API Overview for Express Connect - Express Connect - Alibaba Cloud - Express Connect

Query the list of tags that are bound to cloud resources.

Operation description

You must specify at least the ResourceId.N or Tag.N (Tag.N.Key and Tag.N.Value) parameter in the request to determine the query object.
Tag.N is a tag of the resource, which consists of a key-value pair. If you specify only Tag.N.Key, all tag values associated with the specified 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 all the specified tag key-value pairs.
If you specify multiple tag key-value pairs, the results contain resources that include all the specified 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:ListTagResources

get

BandwidthPackage

acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}

Address

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

RouteTable

acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTable}

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

vpc:tag

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The type of the resource. Valid values: VPC: VPC instance. VSWITCH: vSwitch instance. ROUTETABLE: route table instance. EIP: Elastic IP Address (EIP) instance. VPNGATEWAY: VPN gateway instance. NATGATEWAY: NAT gateway instance. COMMONBANDWIDTHPACKAGE: EIP bandwidth plan instance. PREFIXLIST: prefix list instance. PUBLICIPADDRESSPOOL: IP address pool instance. IPV4GATEWAY: IPv4 gateway instance. IPV6GATEWAY: IPv6 gateway instance. NETWORKACL: network ACL instance. TRAFFICMIRRORFILTER: traffic mirroring filter instance. TRAFFICMIRRORSESSION: traffic mirroring session instance. FLOWLOG: flow log instance. HAVIP: high-availability virtual IP address (HAVIP) instance. DHCPOPTIONSSET: DHCP options set instance. GATEWAYENDPOINT: gateway endpoint instance. IPV6ADDRESS: IPv6 address instance. Note The resource type value is case-insensitive.	VPC
NextToken	string	No	The token for the next query. Valid values: If this is the first query or no next query exists, you do not need to set this parameter. If a next query exists, set the value to the NextToken value returned in the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 50.	50
ResourceId	array	No	The IDs of the resources. You can specify up to 50 resource IDs.	vpc-bp16qjewdsunr41m1****
	string	No	The ID of the resource. You can specify up to 50 resource IDs. Note You must specify at least one of the ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value) parameters.	vpc-bp16qjewdsunr41m1****
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
Tag	array<object>	No	The tag information.	ListTagResources
	object	No	The tag of the resource.
Key	string	No	The key of the tag. You can specify up to 20 tag keys. The tag key can be up to 128 characters in length. It cannot be an empty string. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Note You must specify at least one of the ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value) parameters.	FinanceDept
Value	string	No	The value of the tag. You can specify up to 20 tag values. The tag value can be up to 128 characters in length and can be an empty string. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Note You must specify at least one of the ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value) parameters.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The returned information.
NextToken	string	The token for the next query. Valid values: If NextToken is empty, no next query exists. If NextToken has a return value, the value is the token used to start the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	DE65F6B7-7566-4802-9007-96F2494AC512
TagResources	object
TagResource	array<object>	The information about the resources to which tags are bound.
	object	The information about the resource to which a tag is bound.
ResourceType	string	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 (HAVIP) instance. DHCPOPTIONSSET: DHCP options set instance. GATEWAYENDPOINT: gateway endpoint instance.	VPC
TagValue	string	The tag value.	FinanceJoshua
ResourceId	string	The resource ID.	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.