DetachDisks

1. API Description

This API is used to detach one or more disks from an instance.

Note

• Disks to be detached should be attached to the same instance. If any of the disks is undetachable, the operation will not be performed.

• Only operations on disks with the status of IN_USE are supported.

• Only operations on disks that are detachable (portable = true) are supported.

• Only operations on data disks are supported.

• A maximum of 10 disks can be detached from an instance in one request.

• This API is an async API. A request ID is returned after the creation request is sent. However, it does not mean the operation has been completed. You can use DescribeDisks to query the status of the disk. If the status changes from IN_USE to AVAILABLE, it means that the disk is detached successfully.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
diskIds	Yes	Array of String	ID list of disks to be detached.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Example

Detach one or more disks from an instance.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DetachDisks
<Common Request Params>

Request:
{
  "diskIds": [
    "your-disk-id"
  ]
}

Response:
{
  "requestId": "T86A56634-582A-4615-BBE2-ABFE192EE7CE",
  "response": {
    "requestId": "T86A56634-582A-4615-BBE2-ABFE192EE7CE"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
400	INVALID_DISK_NOT_PORTABLE	Disk does not detachable.
400	UNSUPPORTED_OPERATION_DISK_STATUS	Operations on the disk with current status are not supported.
400	UNSUPPORTED_OPERATION_INSTANCE_STATUS	Operations on the instance with current status are not supported.
400	UNSUPPORTED_OPERATION_DISK_SYSTEM_TYPE	Only operations on data disks are supported.
400	UNSUPPORTED_OPERATION_DISK_NO_ATTACH	Disk is not attached to any instance.
400	UNSUPPORTED_OPERATION_DISK_BELONG_MULTIPLE_INSTANCE	Disks are attached to different instances.