[Disks] attachDisk


Process Overview of the Function

Disk is added to the specified virtual server.

Request Parameters

Specify the following parameter(s) when executing this function.


VM Identifier

Specify the identifier of a target virtual server to which the disk is to be added. .
The virtual server identifier can be obtained from the 4.1. listNodes function.
In the 4.1. listNodes function response object, the corresponding field is, identifier.


Datastore ID

Specify the ID of the datastore to which the target disk is to belong.


Disk Size [GB]

Specify the disk size (disk space) of the target disk.

Unit is in GB (GigaByte).


Swap Setting

Specify whether the target disk is to be a swap disk or not.
true : Swap disk
false : Not a swap disk


Mount Point Specification

Specify the mount point to be allocated to the target disk.


Add to fstab Specification

Specify whether to add the target disk to /etc/fstab or not.
When adding to /etc/fstab/, the below-mentioned parameter, require_format_disk, needs to be set to true,
and the disk needs to be formatted.

true : Add to fstab
false : Do not add to fstab


Disk Format Requirement

Specify whether to format the target disk or not.

1 : Format
0 : Do not format


Response Object

If the request to add the specified disk is successful then the following format is used in the response.


Returns the id allocated to the added disk.

If the request to add the specified disk failed then the resulting error message is returned.


Request Sample


Response Sample

"disk_id": ID_of_Disk

Note: GMO CLOUD AMERICA INC. does not make any guarantee with regard to the content of this manual and will not be held responsible for any damages resulting from customers or third parties.

Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk