TagResources - Virtual Private Cloud - Alibaba Cloud Documentation Center

Adds a tag to a resource.

Operation description

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:

Each tag key that is added to an instance must be unique.
You cannot create tags without adding them to instances. All tags must be added to instances.
You can add at most 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:
- For mandatory resource types, indicate with a prefix of * .
- 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	Ipam `acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}` IpamPool `acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}` IpamScope `acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource.	cn-beijing
ResourceId	array	Yes	The IDs of the resources.
ResourceId	string	Yes	The ID of the resource. You can enter at most 20 resource IDs. Note When you call this operation, you must specify ResourceId.N.	ipam-uq5dcfc2eqhpf4****
ResourceType	string	Yes	The resource type. Valid values: IPAM IPAMSCOPE IPAMPOOL	IPAM
Tag	array<object>	Yes	The tags to add to the resources.
Tag	object	Yes
Key	string	No	The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It cannot start with a `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It cannot start with a `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BF872550-9700-52FD-839C-4D3F05543FA8

Examples

Sample success responses

JSONformat

{
  "RequestId": "BF872550-9700-52FD-839C-4D3F05543FA8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.ResourceIds	The input parameter ResourceIds that is mandatory for processing this request is not supplied.	Parameter ResourceIds not passed in.
400	MissingParameter.ResourceType	The input parameter ResourceType that is mandatory for processing this request is not supplied.	Parameter ResourceType not passed in.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The parameter Tags was not passed in.
400	MissingParameter.Tags	The input parameter Tags that is mandatory for processing this request is not supplied.	Parameter ResourceType not passed in.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The parameter Tags was not passed in.
400	IllegalParamSize.ResourceIds	The number of Param ResourceIds exceeded the limit.	The number of ResourceIds parameters passed in exceeds the limit.
400	IllegalParamSize.Tags	The number of Parameter Tags exceeded the limit.	The number of ResourceIds parameters passed in exceeds the limit.
400	DuplicatedParam.TagKey	TagKey duplicate.	TagKey parameter duplicate
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	The IPAM entered does not exist.
400	ResourceNotFound.IpamScope	The specified resource of IPAM scope is not found.	The input IPAM scope does not exist.
400	IllegalParam.TagKey	The input parameter TagKey is invalid.	Illegal parameter TagKey.
404	ResourceNotFound.IpamPool	The dependent IPAM pool is not found.	The IPAM pool does not exist.

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

Change history

Change time	Summary of changes	Operation
2024-09-12	The Error code has changed	View Change Details