[Disks] listDisks

listDisks

Process Overview of the Function

List of disks is retrieved.
When the virtual server ID is specified, the list of disks attached to the appropriate virtual server is returned.
In all other cases, the list of disks in the GMO Cloud Hosting system is returned.

Request Parameter

Specify the following parameter when executing this function.

ParameterDescriptionRequired
Identifier

VM Identifier

Specify the identifier of a virtual server.
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.

×

Response Object

The following format is used in the response.

ParameterDescription
add_to_linux_fstab Returns whether the disk is added to Linux fstab or not.
true : Disk is added to fstab
false : Disk is not added to fstab
built

Returns the build status of the virtual server.

true : Virtual server is in operation.
false : Status other than above

created_at

Returns the date and time the disk is created.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

data_store_id Returns the ID of the datastore that the appropriate disk belongs to.
disk_size

Returns the disk size (disk space) of the appropriate disk.

Unit is in GB (GigaBytes).

disk_vm_number Returns the allocation sequence number on the virtual server using the appropriate disk.
has_autobackups

Returns automatic backup setting of the appropriate disk.

true : Automatic backup is enabled.
false : Automatic backup is disabled.

id Returns the ID allocated to the appropriate disk.
identifier Returns the identifier allocated to the appropriate disk.
is_swap

Returns whether the appropriate disk is a swap disk or not.

true : Swap disk
false : Not a swap disk

locked

Returns the status of the lock on the apprioriate disk.

true : Disk is locked
false : Status other than above

mount_point Returns the mount point set on the appropriate disk.
primary

Returns whether the appropriatedisk is a primary disk or not.

true : Primary disk
false : Not a primary disk

updated_at

Returns the date and time the settings on the appropriate disk is last updated.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

virtual_machine_id Returns the ID of the virtual server that the appropriate disk is connected to.

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=listDisks&AccessKeyId=AccessKeyId&Version=1.0&Signature=Signature

Response Sample

{
"Id_of_Disks": {
"created_at": "2012-07-19T12:32:33+09:00",
"add_to_linux_fstab": NULL,
"disk_size": 5,
"updated_at": "2012-07-19T12:32:46+09:00",
"primary": true,
"data_store_id": Id_of_DataStore,
"id": Id_of_Disks,
"disk_vm_number": 1,
"is_swap": false,
"mount_point": NULL,
"identifier": "Identifier_of_Disks ",
"virtual_machine_id":Id_of_VM,
"has_autobackups": true,
"built": true,
"locked": false
}
}

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

0 Comments

Article is closed for comments.
Powered by Zendesk