Add tags to instances by calling the TagResources API - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

If you have many instances, you can create tags and add them to instances, and then filter instances by tag.

A tag consists of a key-value pair. Each key must be unique within a region for an Alibaba Cloud account. Different keys can have the same value.
If the specified tag does not exist, it is automatically created and added to the instance.
If the specified tag has the same key as an existing tag, the new tag overwrites the existing tag.
You can add up to 20 tags to each instance.
You can add tags to up to 50 instances in each request.

You can also add tags to instances in the Tair (Redis OSS-compatible) console. For more information, see Create a tag.

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

kvstore:TagResources

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
ResourceType	string	Yes	The resource type. Set the value to INSTANCE.	INSTANCE
ResourceId	array	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
	string	No	The ID of the instance. You can specify multiple IDs. Note This parameter indicates the ID of the Nth instance. For example, ResourceId.1 specifies the ID of the first instance and ResourceId.2 specifies the ID of the second instance.	r-bp1zxszhcgatnx****
Tag	array<object>	Yes	The tags of the instance.
	object	No	The object.
Key	string	Yes	The key of the tag associated with the instance. Note N specifies the serial number of the tag. For example, Tag.1.Key specifies the key of the first tag and Tag.2.Key specifies the key of the second tag. If the key of the tag does not exist, the key is automatically created.	demokey
Value	string	Yes	The value of the tag associated with the instance. Note N specifies the serial number of the tag. For example, Tag.1.Value specifies the value of the first tag and Tag.2.Value specifies the value of the second tag.	demovalue

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	4BD4E308-A3D8-4CD1-98B3-0ADAEE38****

Examples

Success response

JSON format

{
  "RequestId": "4BD4E308-A3D8-4CD1-98B3-0ADAEE38****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NumberExceed.Tags	The Tags parameter number is exceed, Valid is 20.
400	InvalidTagKey.Malformed	The specified parameter Tag.n.Key or TagKey.n is not valid.
400	InvalidTagValue.Malformed	The specified parameter Tag.n.Value is not valid.
400	InvalidParameter.ResourceId	The specified parameter ResourceId.n is not valid.
400	MissParameter.TagOrResourceId	The parameter Tag.n or ResourceId.n is needed.	The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.
400	InvalidParameter.Scope	The specified parameter Scope is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed.
400	NumberExceed.CustomTags	The Custom Tags parameter number is exceed. Valid is 20.
400	Duplicate.TagKey	The specified parameter Tag.n.Key is duplicated.
400	InvalidParameter.ResourceType	The specified parameter ResourceType is not valid.
400	OperationDenied.QuotaExceed	The Tags parameter number is exceed. Valid is 20.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.