All Products
Search
Document Center

:UntagResources

Last Updated:Dec 09, 2024

Removes tags from Tair (Redis OSS-compatible) instances.

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 ApsaraDB for Redis console. For more information, see Remove a tag.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
kvstore:UntagResourcesdelete
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceTypestringYes

The resource type. Set the value to INSTANCE.

INSTANCE
AllbooleanNo

Specifies whether to remove all tags from the instance. Valid values:

  • true: removes all tags from the instance.
  • false (default): does not remove all tags from the instance.
Note If you specify both this parameter and the TagKey.N parameter, this parameter does not take effect.
false
ResourceIdarrayYes

The IDs of the instances.

stringYes

The ID of the instance.

r-bp1zxszhcgatnx****
TagKeyarrayNo

The list of tag keys.

stringNo

The tag key.

demokey

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

601B6F25-21E7-4484-99D5-3EF2625C****

Examples

Sample success responses

JSONformat

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

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.The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.
400InvalidParameter.ScopeThe specified parameter Scope is not valid.-
400NumberExceed.ResourceIdsThe ResourceIds parameter number is exceed.-
400NumberExceed.TagsThe Tags parameter 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.The specified instance does not exist

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

Change history

Change timeSummary of changesOperation
2023-07-20API Description Update. The Error code has changedView Change Details