A backup is a full copy of a volume stored in an external service. The service can be configured. The only supported service for now is Object Storage. A backup can subsequently be restored from the external service to either the same volume that the backup was originally taken from, or to a new volume. backup and restore operations can only be carried out on volumes which are in an unattached and available state.
When you create, list, or delete backups, these status values are possible:
| Status | Description |
|---|---|
|
creating |
The backup is being created. |
|
available |
The backup is ready to be restored to a volume. |
|
deleting |
The backup is being deleted. |
|
error |
An error has occurred with the backup. |
|
restoring |
The backup is being restored to a volume. |
|
error_restoring |
An error occurred during backup restoration to a volume. |
In the event of an error, more information about the error
can be found in the fail_reason field for
the backup.
| Method | URI | Description |
|---|---|---|
| POST | /v2/{tenant_id}/backups | Creates a Block Storage backup from a volume. |
| GET | /v2/{tenant_id}/backups | Lists backups defined in Block Storage to which the tenant who submits the request has access. |
| GET | /v2/{tenant_id}/backups/detail | Lists detailed information for backups defined in Block Storage to which the tenant who submits the request has access. |
| GET | /v2/{tenant_id}/backups/{backup_id} | Shows details for a specified backup. |
| DELETE | /v2/{tenant_id}/backups/{backup_id} | Deletes a specified backup. |
| POST | /v2/{tenant_id}/backups/{backup_id}/restore | Restores a Block Storage backup to an existing or new Block Storage volume. |
