Call the UntagResources API to remove tags from instances - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can remove up to 20 tags at a time.
If a tag is removed from an instance and is not added to other instances, the tag is deleted.

You can also remove tags from instances in the Tair (Redis OSS-compatible) console. For more information, see Remove 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:UntagResources

delete

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. Call DescribeRegions to query available regions.	cn-hangzhou
ResourceType	string	Yes	The resource type. Set the value to INSTANCE.	INSTANCE
All	boolean	No	Specifies whether to remove all tags from the instance. Valid values: 167 168 169 true: removes all tags. 170 171 172 false (default): does not remove all tags. Note If you specify both this parameter and the TagKey.N parameter, this parameter does not take effect.	false
ResourceId	array	Yes	The IDs of the instances.	r-bp1zxszhcgatnx****
	string	No	The ID of the instance.	r-bp1zxszhcgatnx****
TagKey	array	No	The list of tag keys.	demokey
	string	No	The tag key.	demokey

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	601B6F25-21E7-4484-99D5-3EF2625C****

Examples

Success response

JSON format

{
  "RequestId": "601B6F25-21E7-4484-99D5-3EF2625C****"
}

Error codes

HTTP status code	Error code	Error message	Description
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 Tag and ResourceId parameters cannot both be empty. Specify at least one.
400	InvalidParameter.Scope	The specified parameter Scope is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed.
400	NumberExceed.Tags	The Tags parameter number is exceed.
400	Duplicate.TagKey	The specified parameter Tag.n.Key is duplicated.
400	InvalidParameter.ResourceType	The specified parameter ResourceType is not valid.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.