All Products
Search
Document Center

ApsaraDB for MongoDB:UntagResources

Last Updated:Mar 15, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:UntagResourcesWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

cn-hangzhou
ResourceTypestringYes

The resource type. Set the value to INSTANCE.

INSTANCE
AllbooleanNo

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
ResourceGroupIdstringNo

The ID of the resource group.

sg-bpxxxxxxxxxxxxxxxxxx
ResourceIdarrayYes

The resource IDs.

stringYes

The ID of the resource.

dds-bpxxxxxxxx
TagKeyarrayNo

The tag keys of the resource.

stringNo

The key of the tag.

PRODUCT

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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 codeError codeError messageDescription
400InvalidTagKey.MalformedThe specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.-
400InvalidTagValue.MalformedThe specified parameter 'Tag.n.Value' is not valid.-
400InvalidParameter.ResourceIdThe specified parameter 'ResourceId.n' is not valid.-
400MissParameter.TagOrResourceIdThe parameter 'Tag.n'' or 'ResourceId.n' is needed.-
400InvalidParameter.ScopeThe specified parameter 'Scope' is not valid.-
400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed.-
400NumberExceed.TagsThe Tags parameter's number is exceed.-
400Duplicate.TagKeyThe specified parameter 'Tag.n.Key' is duplicated.-
400InvalidParameter.ResourceTypeThe specified parameter 'ResourceType' is not valid.-
404InvalidDbInstanceId.NotFoundSpecified 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 timeSummary of changesOperation
2023-07-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404