Express Connect Circuit Tag API Overview - Express Connect - Alibaba Cloud - Express Connect

Queries tags bound to Express Connect resources.

Operation description

To query a specific object, specify ResourceId.N or Tag.N (Tag.N.Key and Tag.N.Value) in the request.
Tag.N is a resource tag consisting of a key-value pair. If you specify only Tag.N.Key, all tag values associated with the specified key are returned. If you specify only Tag.N.Value, an error message is returned.
If you specify both Tag.N and ResourceId.N to filter tags, ResourceId.N must match all specified key-value pairs.
If you specify multiple key-value pairs, only resources that contain all specified key-value 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 type of the resource. Valid values: PHYSICALCONNECTION: Express Connect circuit. VIRTUALBORDERROUTER: virtual border router (VBR). ROUTERINTERFACE: router interface.	PHYSICALCONNECTION
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Not required for the first request. Specify the token obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
ResourceId	array	No	The resource IDs.
	string	No	The resource ID. You can specify up to 20 resource IDs.	pc-bp16qjewdsunr41m1****
Tag	array<object>	No	The tags.
	object	No
Key	string	No	The tag key of 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 tag key cannot start with `aliyun` or `acs:`.	FinanceDept
Value	string	No	The tag value of 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 `aliyun` or `acs:`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object
NextToken	string	A pagination token. Use it 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, use it in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
TagResources	object
TagResource	array<object>	The tags added to the resource.
	object
ResourceType	string	The type of the resource. Valid values: PHYSICALCONNECTION: Express Connect circuit. VIRTUALBORDERROUTER: VBR. ROUTERINTERFACE: router interface.	PHYSICALCONNECTION
TagValue	string	The tag value of the resource.	FinanceJoshua
ResourceId	string	The resource ID.	pc-bp16qjewdsunr41m1****
TagKey	string	The tag key of the resource.	FinanceDept

Examples

Success response

JSON format

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TagResources": {
    "TagResource": [
      {
        "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 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.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.
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.