UntagResources - ApsaraDB RDS - Alibaba Cloud Documentation Center

Removes tags from one or more instances.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

Usage notes

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 automatically deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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
rds:UntagResources	WRITE	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The type of the resource. Set the value to INSTANCE.	INSTANCE
All	boolean	No	Specifies whether to delete all tags of the instance. Valid values: true false Default value: false. Note This parameter is valid if parameters that contain TagKey.N are not specified.	false
ResourceId	array	Yes	The instance ID. You can remove tags from N instances at a time. Valid values of N: 1 to 50.
	string	Yes	The instance ID.	rm-uf6wjk5xxxxxxx
TagKey	array	No	The list of tag keys. You can delete N tag keys at a time. Valid values of N: 1 to 20. The value of this parameter cannot be an empty string.
	string	No	The key of the tag.	key1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	601B6F25-21E7-4484-99D5-3EF2625C0088

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	NumberExceed.Tags	The number of parameter Tags is exceed, Valid : 20	-
400	NumberExceed.ResourceIds	The number of ResourceIds parameter is exceed , Valid : 50	-
400	InvalidTagValue.Malformed	The Tag.N.Value parameter is blank	The Tag.N.Value is empty.
400	MissingParameter	The parameter - ResourceIds.N should not be null	-
400	InvalidTagKey.Malformed	The Tag.N.Key parameter is blank	The operation failed. The Tag.N.Key parameter is empty.
400	InvalidResourceId.NotFound	ResourceId does not refer to an existing DB instance.	The operation failed. The value of the ResourceId parameter is not the ID of an existing RDS instance.

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

Change history

Change time

Summary of changes

Operation

2022-09-01

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change