All Products
Search
Document Center

Elastic Compute Service:DetachDisk

Last Updated:Mar 26, 2024

Detaches a pay-as-you-go data disk or a system disk from an Elastic Compute Service (ECS) instance.

Operation description

When you call this operation, take note of the following items:

  • The disk that you want to detach must be in the In_Use state.
  • The instance from which you want to detach a pay-as-you-go data disk must be in the Running or Stopped state.````
  • The instance from which you want to detach a system disk must be in the Stopped state.``
  • If the OperationLocks parameter in the response contains "LockReason" : "security", the instance is locked for security reasons and no operations are allowed on the instance.
  • DetachDisk is an asynchronous operation. After you call the operation, a disk is detached from an instance in approximately 1 minute.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the ECS instance from which you want to detach the disk.

i-bp67acfmxazb4p****
DiskIdstringYes

The ID of the disk that you want to detach.

d-bp67acfmxazb4p****
DeleteWithInstancebooleanNo

Specifies whether to release the system disk when the instance from which you want to detach the system disk is released. Valid values:

  • true: releases the system disk when the instance is released.
  • false: does not release the system disk when the instance is released. The system disk is retained as a pay-as-you-go data disk.

Default value: true.

If you specify this parameter, take note of the following items:

  • You cannot specify this parameter for disks for which the multi-attach feature is enabled.
  • If you detach a data disk, the default value of this parameter is false.
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe input parameter is mandatory for processing this request is empty.A required parameter is not specified.
400InvalidRegionId.MalFormedThe specified RegionId is not valid.The specified region does not exist.
400InvalidOperation.InstanceTypeNotSupportThe instance type of the specified instance does not support hot detach disk.-
403IncorrectDiskStatusThe current disk status does not support this operation.The disk is in a state that does not support the current operation. Make sure that the disk is available and that your account has no overdue payments.
403DiskNotPortableThe specified disk is not a portable disk.The specified disk is not removable.
403InstanceLockedForSecurityThe instance is locked due to security.The operation is not supported while the instance is locked for security reasons.
403DependencyViolationThe specified disk has not been attached on the specified instance.-
403DiskTypeViolationThe specified disk is a system disk and cannot support the operation.The specified disk is a system disk and cannot be detached.
403IncorrectInstanceStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
403UserNotInTheWhiteListThe user is not in disk white list.You are not authorized to manage the disk. Try again when you are authorized.
403InvalidInstance.ImageCategoryThe image category of the specified instance does not support detaching system disk.The specified system disk cannot be detached from the instance while the image of the instance is in the current state. Possible cause: The image that was used to create the instance has been deleted.
403DeleteWithInstance.ConflictMulti attach disk cannot be set to DeleteWithInstance attribute.Disks for which the multi-attach feature is enabled do not support the DeleteWithInstance attribute.
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
404InvalidDiskId.NotFoundThe specified disk does not exist.The specified disk does not exist. Check whether the disk ID is correct.
404InvalidDisk.AlreadyDetachedThe specified disk has been detached.The specified disk has been detached.
404InvalidDiskId.OperationNotSupportedThe operation is not supported due to base image not exist.-
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred. Try again later.

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

Change history

Change timeSummary of changesOperation
2023-11-24The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 500