All Products
Search
Document Center

Elastic Compute Service:UntagResources

Last Updated:Sep 27, 2024

Removes tags from Elastic Compute Service (ECS) resources. After a tag is removed from a resource, the tag is automatically deleted if it is not added to other resources.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ResourceTypestringYes

The type of the resource. Valid values:

  • instance: ECS instance
  • disk: disk
  • snapshot: snapshot
  • image: image
  • securitygroup: security group
  • volume: storage volume
  • eni: elastic network interface (ENI)
  • ddh: dedicated host
  • ddhcluster: dedicated host cluster
  • keypair: SSH key pair
  • launchtemplate: launch template
  • reservedinstance: reserved instance
  • snapshotpolicy: automatic snapshot policy
  • elasticityassurance: elasticity assurance
  • capacityreservation: capacity reservation
  • command: Cloud Assistant command
  • invocation: Cloud Assistant command execution result
instance
AllbooleanNo

Specifies whether to remove all tags from the resource. This parameter takes effect only if you do not specify TagKey.N. Valid values:

  • true
  • false

Default value: false.

false
ResourceIdarrayYes

The resource IDs. Valid values of N: 1 to 50.

stringYes

The ID of resource N.

i-bp67acfmxazb4ph****
TagKeyarrayNo

The tag keys. Valid values of N: 1 to 20.

stringNo

The key of tag N.

TestKey

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

C46FF5A8-C5F0-4024-8262-B16B639225A0

Examples

Sample success responses

JSONformat

{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}

Error codes

HTTP status codeError codeError messageDescription
400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed , Valid : 50-
400NumberExceed.TagsThe Tags parameter's number is exceed , Valid : 20-
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.The maximum number of tags on resource is exceeded.
400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400InvalidTagCountThe specified tags are beyond the permitted range.The number of specified tags exceeds the upper limit.
400Invalid.ScopeThe specified scope is invalid.The specified Scope parameter is invalid.
403PermissionDenied.TagOwnerBidThe specified operator not have permission to set TagOwnerBid value.-
403PermissionDenied.TagOwnerUidThe specified operator not have permission to set TagOwnerUid value.You are not authorized to specify the TagOwnerUid parameter.
403PermissionDenied.ScopeThe specified operator not have permission to set Scope value.You are not authorized to specify the Scope parameter.
403InvalidResourceId.NotSupportedThe specified ResourceId does not support tagging.The specified resource does not support tagging.
403NoPermissionKey.Scope%s-
403NoPermission.TagThe operator is not permission for the tag.You are not authorized to manage the tag.
403Param.ConflictThe specified all is true, but the specified TagKey.N is not empty.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
404InvalidRegionId.NotFound%sThe specified region ID does not exist.
404MissingParameter.ResourceIdsThe parameter - ResourceIds.N should not be null-
404MissingParameter.TagOwnerUidThe parameter - TagOwnerUid should not be nullThe TagOwnerUid parameter is required.
404MissingParameter.TagOwnerBidThe parameter - TagOwnerBid should not be nullThe TagOwnerBid parameter is required.
404MissingParameter.ResourceTypeThe parameter - ResourceType should not be null-
404MissingParameter.TagsThe parameter - Tags should not be nullThe tag-related parameters are required.
404MissingParameter.RegionIdThe parameter - RegionId should not be nullThe RegionId parameter is required.
404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.The specified resource does not exist. Check whether the ResourceId parameter is correct.
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.The specified resource type does not exist.
404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region ID does not exist.

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

Change history

Change timeSummary of changesOperation
No change history