Use the UntagResources API to remove tags from EBS resources - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Removes tags from specified Elastic Block Storage (EBS) resources.

Operation description

You can remove up to 20 tags at a time.
After a tag is removed from an EBS resource, the tag is automatically deleted if the tag is not added to any instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ebs:UntagResources

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	Yes	The ID list of the resource. You can specify up to 50 resource IDs in each call.	disk-123
	string	No	The ID of resource N. Valid values of N: 1 to 50.	pair-cn-c4d2t7f****
TagKey	array	No	The list of tag keys. You can specify up to 20 tag keys in the list.	disk-123
	string	No	The key of tag N. Valid values of N: 1 to 20.	TestKey
All	boolean	No	Specifies whether to remove all tags from the resource. This parameter is valid only when the TagKey.N parameter is not specified. Valid values: true: removes all tags from the resource. false: does not remove all tags from the resource. Default value: false.	false
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The type of the resource. Valid values: dedicatedblockstoragecluster: dedicated block storage cluster diskreplicapair: the replication pair. diskreplicagroup: replication pair-consistent group	diskreplicapair
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	0c593ea1-3bea-11e9-b96b-88e9fe63****

Response elements

Element	Type	Description	Example
	object	TagResponse
RequestId	string	The ID of the request. The request ID is returned regardless of whether the call is successful.	C46FF5A8-C5F0-4024-8262-B16B6392****

Examples

Success response

JSON format

{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B6392****"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed , Valid : 50
400	NumberExceed.Tags	NumberExceed.Tags
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.