TagResources - VPN Gateway - Alibaba Cloud Documentation Center

Creates and adds tags to resources.

Operation description

Tags are used to classify instances. Each tag consists of a key-value pair. Before you use tags, take note of the following limits:

The keys of tags that are added to the same instance must be unique.
You cannot create tags without adding them to instances. All tags must be added to instances.
Tag information is not shared across regions.

For example, you cannot view the tags that are created in the China (Hangzhou) region from the China (Shanghai) region.
Virtual private clouds (VPCs), route tables, vSwitches, and elastic IP addresses (EIPs) that belong to the same Alibaba Cloud account and are deployed in the same region share tag information with each other.

For example, if you added a tag to a VPC, the tag is available to vSwitches, route tables, and EIPs that belong to the same account and are deployed in the same region in which the VPC is created. You can select this tag from the editing page without the need to enter the tag again. You can modify the key and the value of a tag or remove a tag from an instance. After you delete an instance, all tags that are added to the instance are deleted.
You can add up to 20 tags to each instance. Before you add a tag to an instance, the system automatically checks the number of existing tags. An error message is returned if the maximum number of tags is reached.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:TagResources	update	BandwidthPackage `acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}` Address `acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}` NatGateway `acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}` RouteTable `acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}` VPC `acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}` VpnGateway `acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}` *VSwitch `acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}`	vpc:tag	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Valid values: VPC: a VPC VSWITCH: a vSwitch ROUTETABLE: a route table EIP: an EIP VpnGateway: a VPN gateway NATGATEWAY: a NAT gateway COMMONBANDWIDTHPACKAGE: an EIP bandwidth plan	VPC
ResourceId	array	Yes	The resource ID. You can specify at most 20 IDs.
	string	Yes	The resource ID. You can specify up to 20 resource IDs. Note When you call this operation, ResourceId.N is required.	vpc-bp16qjewdsunr41m1****
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Tag	array<object>	Yes	The tag information.	TagResources
	object	Yes
Key	string	No	The key of the tag that is added to the resource. You can specify at most 20 tag keys. The key cannot exceed 128 characters in length. The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. Note When you call this operation, the Tag.N.Key parameter is required and cannot be an empty string.	FinanceDept
Value	string	No	The value of the tag that is added to the resource. You can specify at most 20 tag values. The tag value cannot exceed 128 characters in length. The value cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Note When you call this operation, the Tag.N.Value parameter is required and can be an empty string.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	C46FF5A8-C5F0-4024-8262-B16B639225A0

Examples

Sample success responses

JSONformat

{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}

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	MissingParam	%s	-
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.NotAllowedCategary	The System tag is not valid	The error message returned because the system tag is invalid.
400	Forbidden.TagKeys	The request does not allow operate this tagkeys	The error message returned because 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	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.
400	MissingParam.Tags	You must specify the Tags parameter.	The error message returned because the Tags 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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-28	The Error code has changed	View Change Details
2023-04-06	The Error code has changed	View Change Details
2023-03-23	The Error code has changed	View Change Details