Creates and binds tags to specified resources.
Operation description
Tags are key-value pairs that classify instances. Limits:
-
Tag keys on the same instance must be unique.
-
Tags must be bound to an instance.
-
Tag information is not shared across regions.
For example, tags created in China (Hangzhou) are not visible in China (Shanghai).
-
VPCs, route tables, vSwitches, and EIPs under the same Alibaba Cloud account and region share tag information.
A tag added to a VPC is available to vSwitches, route tables, and EIPs in the same account and region. You can modify or remove tags. Deleting an instance removes all its tags.
-
Each instance supports up to 20 tags. The system checks the tag count before adding and returns an error if this limit is exceeded.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ResourceType |
string |
Yes |
The resource type. Valid values:
|
VPC |
| ResourceId |
array |
Yes |
The resource ID. You can specify at most 20 IDs. |
vpc-bp16qjewdsunr41m1**** |
|
string |
No |
The resource ID. You can specify up to 20 resource IDs. Note
ResourceId.N is required. |
vpc-bp16qjewdsunr41m1**** |
|
| RegionId |
string |
Yes |
The region ID of the resource. Call the DescribeRegions operation to query available regions. |
cn-hangzhou |
| Tag |
array<object> |
Yes |
The tags to add. |
TagResources |
|
object |
No |
|||
| Key |
string |
No |
The tag key. You can specify up to 20 tag keys. Maximum length: 128 characters. Cannot start with Note
Tag.N.Key is required and cannot be empty. |
FinanceDept |
| Value |
string |
No |
The tag value. You can specify up to 20 tag values. Maximum length: 128 characters. Cannot start with Note
Tag.N.Value is required but can be empty. |
FinanceJoshua |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
C46FF5A8-C5F0-4024-8262-B16B639225A0 |
Examples
Success response
JSON format
{
"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.TagKey.Duplicated | The specified tag key already exists. | The tag resources are duplicated. |
| 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 Tags parameter is not set. |
| 400 | DuplicatedParam.ResourceIds | The parameter of ResourceIds contains duplicate values. | |
| 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.