ChangeDisksAttach

1. API Description

This API is used to attach one or more disks to another instance. These disks are already attached to one instance.

Note

  • Call this API to detach disks (DetachDisks) first and then attach disks (AttachDisks).

  • Status of disks must be IN_USE, and disks are already attached to other instance.

  • Disks are currently attached to the same instance.

  • Quantity of disks cannot exceed available disk numbers of new instance.

  • 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 instance to which disks are attached. If the instance has changed to the new one, it means that the operation is successful.

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.

instanceId

Yes

String

New ID of instance to which the disks to be attached.

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

Attach disks to another instance.

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

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

Response:
{
  "requestId": "T425ED38F-1BE5-4274-B076-9A58C51F21A8",
  "response": {
    "requestId": "T425ED38F-1BE5-4274-B076-9A58C51F21A8"
  }
}

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_FOUND

Disk does not exist.

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

INVALID_DISK_AND_INSTANCE_ZONE_MISMATCHED

The disk and the instance to which you want to attach the disk should reside in the same zone.

400

LIMIT_EXCEEDED_INSTANCE_CAN_ATTACH

Quantity of attached disks exceed available disk numbers of an instance.

400

UNSUPPORTED_OPERATION_DISK_ATTACH_REPEATED

The instance before and after replacement is the same.

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.

Last updated