DescribeTagKeysForExpressConnect - Virtual Private Cloud

Queries the tags of an Express Connect circuit.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The type of the resource. Set the value to PHYSICALCONNECTION, which specifies an Express Connect circuit.	PHYSICALCONNECTION
Keyword	string	No	The keyword of the tag. Fuzzy match is supported. You can specify a keyword to query all tags that contain the keyword.	keyword
RegionId	string	Yes	The ID of the region to which the resource resides. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. 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****
MaxResult	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
ResourceId	array	No	The IDs of the resources. You can specify up to 20 resource IDs.
	string	No	The resource ID. You can specify up to 20 resource IDs.	pc-bp16qjewdsunr41m1****

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. If NextToken is empty, no next page exists. If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
TagKeys	object []	The tag keys.
Type	string	The type of the resource. The value is set to PHYSICALCONNECTION, which indicates an Express Connect circuit.	PHYSICALCONNECTION
TagKey	string	The key of the tag.	FinanceDept

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
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	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The TagKey parameter is not set.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The TagValue parameter is not set.
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	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.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.	The number of resource group IDs has reached the upper limit.
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-09-11

API Description Update,The API operation is not deprecated.,The error codes of the API operation change.

see changesets

Change item	Change content
API Description	API Description Update
API Deprecation Description	The API operation is not deprecated.
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403