Creates tags and adds them to resources.
Usage notes
Tags are used to classify instances. Each tag consists of a key-value pair. Before you use tags, take note of the following items:
- 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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
ResourceType | String | Yes | VPC | The resource type. Valid values:
Note The values are case-insensitive. |
ResourceId.N | String | No | vpc-bp16qjewdsunr41m1**** | The resource ID. You can specify up to 20 IDs. Note When you call this operation, you must specify ResourceId.N. |
RegionId | String | Yes | cn-hangzhou | The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list. |
Tag.N.Key | String | No | FinanceDept | The key of tag N to add to the resource. You must enter at least one tag key and at most 20 tag keys. It cannot be an empty string. The key cannot exceed 64 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with Note When you call this operation, you must specify Tag.N.Key. |
Tag.N.Value | String | No | FinanceJoshua | The value of tag N to add to the resource. You must enter at least one tag value and at most 20 tag values. It can be an empty string. The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with Note When you call this operation, you must specify Tag.N.Value. |
Action | String | Yes | TagResources | The operation that you want to perform. Set the value to TagResources. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | C46FF5A8-C5F0-4024-8262-B16B639225A0 | The request ID. |
Examples
Sample requests
http(s)://[Endpoint]/?ResourceType=VPC
&ResourceId=["vpc-bp16qjewdsunr41m1****"]
&RegionId=cn-hangzhou
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Action=TagResources
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<TagResourcesResponse>
<RequestId>C46FF5A8-C5F0-4024-8262-B16B639225A0</RequestId>
</TagResourcesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}
Error codes
HttpCode | 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 specify TagKeys. |
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 system tag is invalid. |
400 | Forbidden.TagKeys | The request does not allow operate this tagkeys | 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 Tags parameter is not set. |
403 | Forbidden | User not authorized to operate on the specified resource. | You are unauthorized to perform the operation on the specified resource. Acquire the required permissions and try again. |
For a list of error codes, see Service error codes.