[Backup] listBackups

listBackups

Functional Overview

The list of backups for a virtual server is returned. If a backup does not exist, a NULL string is returned.
If the specified virtual server ID is invalid or does not exist then an error is returned.

Request Parameters

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.

FieldDescription
allow_resize_without_reboot Returns whether CPU and memory size can be changed without rebooting the virtual server backup.
true : Size change allowed without reboot
false : Status other than above
allowed_hot_migrate

Returns whether the virtual server backup can be hot migrated or not.

true : Hot migration allowed
false : Status other than above

allowed_swap

Returns whether the virtual server backup can use swap disk or not.

true : Swap disk usage allowed
false : Status other than above

backup_size

Returns the disk space used in the appropriate backup.

Unit is in MB (MegaBytes).

backup_type Returns the backup type for the appropriate backup.
built

Returns the build status of the specified backup.

true : Built status
false : Status other than above

built_at

Returns the date and time the specified backup has completed.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

created_at

Returns the date and time the appropriate backup has completed the build or awaiting execution.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

disk_id Returns the ID of the target disk for the appropriate backup.
id Returns the ID of the appropriate backup.
identifier Returns the identifier of the appropriate backup.
locked

Returns the status of the lock on the backup of the appropriate virtual server.

true : Backup is locked.
false : Status other than above

min_disk_size Returns the minimum disk size.
operating_system Returns the OS type the appropriate virtual server backup has used at the time of the virtual server build.
operating_system_distro Returns the OS distribution type the appropriate virtual server backup has used at the time of the virtual server build.
template_id Returns the ID of the template the appropriate virtual server backup has specified at the time of the virtual server build.
updated_at

Returns the date and time the appropriate backup has been last updated.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

Sample Request

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

Sample Response

{
"Id_of_Backups": {
"built_at": "2012-07-19T12:37:49+09:00",
"disk_id": Id_of_Disk,
"marked_for_delete": false,
"created_at": "2012-07-19T12:35:48+09:00",
"operating_system_distro": "rhel",
"min_memory_size": 128,
"operating_system": "linux",
"template_id": 9,
"allowed_swap": true,
"backup_type": "normal",
"updated_at": "2012-07-19T12:37:50+09:00",
"allow_resize_without_reboot": true,
"id": Id_of_Backups,
"allowed_hot_migrate": true,
"backup_server_id": NULL,
"backup_size": "210520",
"identifier": "Identifier_of_Backups",
"min_disk_size": 5,
"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