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

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	No	PHYSICALCONNECTION	The resource type. Valid values: PHYSICALCONNECTION: an Express Connect circuit. VIRTUALBORDERROUTER: a virtual border router (VBR). ROUTERINTERFACE: a VBR-to-VPC connection.
Keyword	String	No	keyword	The keyword of the tag. The keyword is used to perform a fuzzy match. You can specify a keyword to query all tags that contain the keyword.
RegionId	String	Yes	cn-hangzhou	The region ID 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 and no subsequent 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.
MaxResult	Integer	No	20	The number of entries per page. Valid values: 1 to 100. Default value: 20.
Action	String	Yes	DescribeTagKeysForExpressConnect	The operation that you want to perform. Set the value to DescribeTagKeysForExpressConnect.
ResourceId.N	String	No	pc-bp16qjewdsunr41m1****	The resource ID. You can specify up to 20 resource IDs.

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.
TagKeys	Array of TagKey		The list of tag keys.
TagKey
Type	String	PHYSICALCONNECTION	The resource type. Valid values: PHYSICALCONNECTION: an express Connect circuit. VIRTUALBORDERROUTER: a VBR. ROUTERINTERFACE: a VBR-to-VPC connection.
TagKey	String	FinanceDept	The key of tag N that is added to the resource.

Examples

Sample requests

http(s)://[Endpoint]/?ResourceType=PHYSICALCONNECTION
&Keyword=keyword
&RegionId=cn-hangzhou
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResult=20
&Action=DescribeTagKeysForExpressConnect
&ResourceId=["pc-bp16qjewdsunr41m1****"]
&Common request parameters

Sample success responses

XML format

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

<DescribeTagKeysForExpressConnectResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <TagKeys>
        <Type>PHYSICALCONNECTION</Type>
        <TagKey>FinanceDept</TagKey>
    </TagKeys>
</DescribeTagKeysForExpressConnectResponse>

JSON format

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TagKeys" : [ {
    "Type" : "PHYSICALCONNECTION",
    "TagKey" : "FinanceDept"
  } ]
}

Error codes

HttpCode	Error code	Error message	Description
400	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.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The error message returned because the TagKey parameter is not specified.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The error message returned because the TagValue parameter is not specified.
400	InvalidTagKey	The tag keys are not valid.	The error message returned because the tag key 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.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 perform the operation on the specified resource. Acquire the required permissions and try again.

For a list of error codes, see Service error codes.