Use TagResources to add tags to VPC peering connections - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Creates and attaches tags to one or more specified VPC peering connections.

Operation description

Tags are labels that you assign to instances. Instance tag consists of a key-value pair. Take note of the following limits on tags:

The key of instance tag on an instance must be unique.
Tags must be attached to instances. Unattached tags 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.

Within the same account and region, tag information is shared across different VPC peering connections.

 For example, if a tag is attached to a VPC peering connection within the same account and region, you can directly select and attach this tag to other VPC peering connections on the Edit Tags page without manually entering the key-value pair. You can modify the key and value of a tag, or delete the tag from an instance at any time. If an instance is deleted, all tags attached to the instance are also deleted.

You can attach up to 20 tags to a single instance. Before attaching tags, Alibaba Cloud verifies 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:TagResources

update

*PeerConnection

acs:vpc:*:{#AccountId}:vpcpeer/{#PeeringId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	Yes	The ID of the resource. You can specify up to 20 resource IDs.
	string	No	The ID of the resource. You can specify up to 20 resource IDs.	pcc-bp16qjewdsunr41m1****
Tag	array<object>	Yes	The tag information.
	object	No	The tag information.
Key	string	No	The key of the tag. You must specify at least one tag key and can specify up to 20 tag keys. The value cannot be an empty string. The key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The value of the tag. You must specify at least one tag value and can specify up to 20 tag values. The value can be an empty string. The value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
ResourceType	string	Yes	The resource type. Set the value to PeerConnection, which indicates a VPC peering connection.	PeerConnection
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID of the resource to which you want to create and attach tags. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	C46FF5A8-C5F0-4024-8262-B16B639225A0
Success	boolean	Indicates whether the tags were created and attached. Valid values: true: The tags were created and attached. false: The tags failed to be created and attached.	true

Examples

Success response

JSON format

{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	NumberExceed.Tags	The maximum number of tags is exceeded.	The number of tags has reached the upper limit.
400	NumberExceed.ResourceIds	The maximum number of resource IDs is exceeded.	The number of resource group IDs exceeds the upper limit.
400	Forbidden.TagKeys	The tag key cannot be operated by the request.	You cannot manage the tag key by calling the operation.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	InvalidInstanceIds.NotFound	The instance IDs are not found.	The instance ID is invalid.
400	InvalidInstanceType.NotFound	The instance type is not found.	The instance type is invalid.
400	IllegalParam.TagKey	The param of Tag.Key is illegal.	The specified parameter Tag.Key is invalid.
400	IllegalParam.TagValue	The param of Tag.Value is illegal.	The specified parameter Tag.Value is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.