Creates tags and adds them to specified resources.
Usage notes
Tags are used to classify instances. Each tag consists of a key and a value. Take note of the following limits when you use tags:
- 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, in the China (Shanghai) region, you cannot view the tags that are created in the China (Hangzhou) 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 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 type of the resource. Valid values:
|
RegionId | String | Yes | cn-hangzhou |
The region ID of the resource to which you want to create and add tags. You can call the DescribeRegions operation to query the most recent region list. |
Action | String | Yes | TagResources |
The operation that you want to perform. Set the value to TagResources. |
ResourceId.N | String | Yes | vpc-bp16qjewdsunr41m1**** |
The ID of the resource. |
Tag.N.Key | String | No | FinanceDept |
The key of the tag that is added to the resource. Valid values of N: 1 to 20. The tag key 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 |
Tag.N.Value | String | No | FinanceJoshua |
The value of the tag that is added to the resource. Valid values of N: 1 to 20. The tag value can be an empty string. The key cannot exceed 128 characters in length,
and can contain digits, periods (.), underscores (_), and hyphens (-). The key must
start with a letter but cannot start with |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | C46FF5A8-C5F0-4024-8262-B16B639225A0 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?ResourceType=VPC
&RegionId=cn-hangzhou
&Action=TagResources
&ResourceOwnerId=111
&ResourceId=["vpc-bp16qjewdsunr41m1****"]
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&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 |
---|---|---|---|
403 | Forbidden | User not authorized to operate on the specified resource. | The error message returned because you are not authorized to perform the operation on the specified resource. Acquire the required permissions and try again. |
For a list of error codes, visit the API Error Center.