Add Tags to Express Connect Circuits with TagResources API - Express Connect - Alibaba Cloud - Express Connect

Creates and binds tags to specified Express Connect circuit instances by calling the TagResourcesForExpressConnect operation.

Operation description

Tags are labels that you assign to instances. Each tag consists of a key-value pair. Take note of the following items when you use tags:

The tag key of each tag on an instance must be unique.
Tags cannot exist without being bound to an instance. Empty tags that are not bound to instances are not supported.
Tag information is not shared across regions.

For example, tags created in the China (Hangzhou) region are not visible in the China (Shanghai) region.
You can bind up to 20 tags to a single instance. Before binding tags, Alibaba Cloud checks the number of existing tags on the resource. If the limit is exceeded, an error message is 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

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:TagResourcesForExpressConnect

update

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

*VirtualBorderRouter

acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}

*RouterInterface

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

*TrafficQos

acs:vpc:{#regionId}:{#accountId}:trafficqos/{#QosId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Valid values: PHYSICALCONNECTION: Express Connect circuit instance. VIRTUALBORDERROUTER: Virtual Border Router. ROUTERINTERFACE: VBR uplink. TRAFFICQOS: QoS policy.	PHYSICALCONNECTION
RegionId	string	Yes	The region ID of the resource to which you want to create and bind tags. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ResourceId	array	Yes	The resource ID. You can specify up to 20 resource IDs.
	string	No	The resource ID. You can specify up to 20 resource IDs.	pc-bp16qjewdsunr41m1****
Tag	array<object>	Yes	The list of resource tags.
	object	No	The list of resource tags.
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 start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	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 start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

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	InvalidTagScope.NotFound	The tag scope is not found	The resource scope 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	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The TagValue parameter is not set.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The TagKey parameter is not set.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.