AddTags - Elastic Compute Service - Alibaba Cloud Documentation Center

Adds or overwrites one or more tags on various Elastic Compute Service (ECS) resources. You can add tags to instances, cloud disks, snapshots, images, security groups, and other resources for easier management.

Note

This API has been deprecated. We recommend migrating to Ecs(2014-05-26) - TagResources for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

When you invoke this operation, take note of the following items:

You can add up to 20 tags to each Elastic Compute Service (ECS) resource.
The tag key (Tag.N.Key) and tag value (Tag.N.Value) must be specified as a key-value pair.
If the tag key (Tag.N.Key) already exists on the specified resource, the original tag value is automatically overwritten with the new tag value (Tag.N.Value).

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

ecs:AddTags

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The type of the resource. Valid values: instance: ECS instance disk: cloud disk snapshot: snapshot image: image securitygroup: security group volume: storage volume eni: Elastic Network Interface (ENI) ddh: dedicated host keypair: SSH key pair launchtemplate: launch template reservedinstance: reserved instance snapshotpolicy: automatic snapshot policy All valid values are in lowercase.	instance
ResourceId	string	Yes	The ID of the resource to which you want to add tags. For example, when ResourceType is set to instance, ResourceId is the instance ID.	i-bp1gtjxuuvwj17zr****
Tag	array<object>	Yes	The tags.
	object	No
key	string	No	The tag key of the resource. Note To improve compatibility, use the Tag.N.Key parameter.	test
Key	string	No	The tag key of the resource. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. The tag key cannot contain http:// or https://.	TestKey
Value	string	No	The tag value of the resource. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with aliyun or acs:. The tag value cannot contain http:// or https://.	TestValue
value	string	No	The tag value of the resource. Note To improve compatibility, use the Tag.N.Value parameter.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.
403	QuotaExceed.Tags	%s	The number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
403	TagKey.Duplication	The TagKey has duplication with others, case-insensitive.	Duplicate values exist in the specified Tag.N.Key parameter. The value of this parameter is not case sensitive. Check whether duplicate parameter values are passed in.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	InvalidResourceId.NotFound	The specified ResourceId is not found in our records.	The specified resource does not exist. Check whether the resource ID is correct.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	The specified resource type does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.