ListTagResourcesForExpressConnect - - Alibaba Cloud ドキュメントセンター

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 assigned to 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
ResourceType	String	Yes	PHYSICALCONNECTION	The resource type. Valid values: PHYSICALCONNECTION:: an Express Connect circuit. VIRTUALBORDERROUTER:: a virtual border router (VBR). ROUTERINTERFACE: a VBR-to-VPC connection.
RegionId	String	Yes	cn-hangzhou	The ID of the region to which the resource belongs. You can call the DescribeRegions operation to query the most recent region list.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is your first query or no next queries are to be sent, ignore this parameter. You must specify the token that is obtained from the previous query as the value of NextToken.
Action	String	Yes	ListTagResourcesForExpressConnect	The operation that you want to perform. Set the value to ListTagResourcesForExpressConnect.
MaxResults	Integer	No	20	The number of entries per page. Valid values: 1 to 100. Default value: 20.
ResourceId.N	String	No	pc-bp16qjewdsunr41m1****	The resource ID. You can specify up to 20 resource IDs.
Tag.N.Key	String	No	FinanceDept	The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The key cannot start with `acs:` or `aliyun`.
Tag.N.Value	String	No	FinanceJoshua	The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.

Response parameters

Parameter	Type	Example	Description
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that is used for the next query.
RequestId	String	54B48E3D-DF70-471B-AA93-08E683A1B45	The request ID.
TagResources	Array of TagResource		The list of returned tags.
TagResource
ResourceType	String	PHYSICALCONNECTION	The resource type. Valid values: PHYSICALCONNECTION:: an Express Connect circuit. VIRTUALBORDERROUTER:: a VBR. ROUTERINTERFACE:: a VBR-to-VPC connection.
TagValue	String	FinanceJoshua	The value of tag N that is added to the resource.
ResourceId	String	pc-bp16qjewdsunr41m1****	The resource ID.
TagKey	String	FinanceDept	The key of tag N that is added to the resource.

Examples

Sample requests

http(s)://[Endpoint]/?ResourceType=PHYSICALCONNECTION
&RegionId=cn-hangzhou
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Action=ListTagResourcesForExpressConnect
&MaxResults=20
&ResourceId=["pc-bp16qjewdsunr41m1****"]
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagResourcesForExpressConnectResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <TagResources>
        <ResourceType>PHYSICALCONNECTION</ResourceType>
        <TagValue>FinanceJoshua</TagValue>
        <ResourceId>pc-bp16qjewdsunr41m1****</ResourceId>
        <TagKey>FinanceDept</TagKey>
    </TagResources>
</ListTagResourcesForExpressConnectResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TagResources" : [ {
    "ResourceType" : "PHYSICALCONNECTION",
    "TagValue" : "FinanceJoshua",
    "ResourceId" : "pc-bp16qjewdsunr41m1****",
    "TagKey" : "FinanceDept"
  } ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTagKey	The tag keys are not valid.	The error message returned because the tag index is invalid.
400	InvalidTagValue	The tag values are not valid.	The error message returned because the tag value is invalid.
400	InvalidInstanceType.NotFound	The instance type is not found	The error message returned because the instance type is not found.
400	InvalidInstanceIds.NotFound	The instanceIds are not found	The error message returned because the instance ID is not found.
400	Forbidden.TagKeys	The request do not allow to operate the tag keys	The error message returned because you do not have the permissions to set the TagKeys parameter.
400	QuotaExceeded.TagNum	Custom Tags quota exceeded	The error message returned because the quota is exceeded.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The error message returned because the tag key already exists.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The error message returned because the number of tags exceeds the upper limit.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.	The error message returned because the number of resource group IDs exceeds the upper limit.
403	Forbidden	User not authorized to operate on the specified resource.	The error message returned because you are unauthorized to manage the specified resource. Acquire the required permissions and try again.
403	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	The error message returned because ResourceId.N and Tag.N are not specified. You must specify at least one of the parameters.

For a list of error codes, visit the API Error Center.