UntagResources - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Removes a tag if the tag is not added to another instance.

Operation description

Note

You can remove up to 20 tags at a time.
If you remove a tag from all 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
dds:UntagResources	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	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 instances. Valid values: true: removes all tags from the instances. false: does not remove all tags from the instances. Note Default value: false. If you specify the TagKey parameter together with this parameter, this parameter does not take effect.	false
ResourceGroupId	string	No	The ID of the resource group.	sg-bpxxxxxxxxxxxxxxxxxx
ResourceId	array	Yes	The resource IDs.
	string	Yes	The ID of the resource.	dds-bpxxxxxxxx
TagKey	array	No	The tag keys of the resource.
	string	No	The key of the tag.	PRODUCT

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	FA3A7F36-DB57-4281-8935-4B9DF61554EB

Examples

Sample success responses

JSONformat

{
  "RequestId": "FA3A7F36-DB57-4281-8935-4B9DF61554EB"
}

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.	-
400	InvalidParameter.Scope	The specified parameter 'Scope' is not valid.	-
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed.	-
400	NumberExceed.Tags	The Tags parameter's 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.	Instance not found. Refresh the page to check whether the instance has been released.

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

Change history

Change time	Summary of changes	Operation
2023-07-13	The Error code has changed	View Change Details