ZStack Cloud Platform
Single Server, Free Trial for One Year
-
Documentation&Tools
Comprehensive product documentation and tools
-
Support & Services
Upholding the value of Customer First and the mission of Serving Customer, ZStack is dedicated to providing secure and stable services for customers.
-
Training & Certification
To educate ZStack partners and interested individuals about cloud computing and to cultivate cloud computing talent.
-
Content
ZStack provides innovative cloud infrastructure for ten major industries
VMware-to-ZStack Case Collection
The report provides three major
solutions and customer case studies for transitioning from VMware to ZStack.
Backup Management
Backup Service (Plus)
The Backup Service feature is provided in a separate module. Before you can use this feature, you need to purchase the Plus License of Backup Service, in addition to the Base License.
Backup Service Operations
CreateVolumeBackup
API Request
URLs
POST zstack/v1/volumes/{volumeUuid}/volume-backupsHeaders
Authorization: OAuth the-session-uuidBody
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
{ "params": { "backupStorageUuid": "1c4b0a3a24533c4faa9b156a0ef98fdf", "name": "backup-1", "description": "a critical volume backup" }, "systemTags": [], "userTags": [] }Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"backupStorageUuid":"1c4b0a3a24533c4faa9b156a0ef98fdf","name":"backup-1","description":"a critical volume backup"}}' http://localhost:8080/zstack/v1/volumes/ec7196ba2d993236aceddd9b31f5d19b/volume-backupsRequest Parameters
Note:
| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| volumeUuid | String | body (contained in the params structure) | The UUID of the volume. | 2.6.0 | |
| backupStorageUuid | String | body (contained in the params structure) | The UUID of the backup storage. | 2.6.0 | |
| name | String | body (contained in the params structure) | The name of the backup. | 2.6.0 | |
| description | String | body (contained in the params structure) | Optional. The detailed description of the backup. | 2.6.0 | |
| resourceUuid | String | body (contained in the params structure) | Optional. Specify a UUID of the backup. | 2.6.0 | |
| volumeReadBandwidth | Long | body (contained in the params structure) | Optional. The maximum speed at which data from the volume is read. | 3.1.0 | |
| volumeWriteBandwidth | Long | body (contained in the params structure) | Optional. The maximum speed at which data is written to the volume. | 3.1.0 | |
| networkReadBandwidth | Long | body (contained in the params structure) | Optional. The network bandwidth for data reads. | 3.1.0 | |
| networkWriteBandwidth | Long | body (contained in the params structure) | Optional. The network bandwidth for data writes. | 3.1.0 | |
| systemTags | List | body | Optional. The system tags. | 2.6.0 | |
| userTags | List | body | Optional. The user tags. | 2.6.0 |
Note: - When you create a volume backup in ZStack Cloud, the data of the volume in a host will be backed up to an ImageStore backup storage. Note that the data exchange in this process will use the backup network. You can add the backupnetwork option to SystemTags.
- Format of the backupnetwork option:
backup::network::cidr::CIDR - Example:
backup::network::cidr::10.0.0.0/8
- Format of the backupnetwork option:
- When you create a volume backup in ZStack Cloud, you can specify how to back up the volume data to the backup storage by adding the fsInfo option to SystemTags.
-
- Format of the fsInfo option:
fsInfo::type::$TYPE::url::$URL::options::$OPTIONS - Example:
fsInfo::type::nfs::url::172.32.1.119:/nas/nfs2::options::nolock,vers=3,rsize=32768,wsize=32768
- Format of the fsInfo option:
- When you create a volume backup in ZStack Cloud, you can configure the concurrency level for the volume backup by adding the volumeLiveBackup option to SystemTags.
- Format of the volumeLiveBackup option:
volumeLiveBackup::parallelismDegree::$NUMBER - Example:
volumeLiveBackup::parallelismDegree::1
- Format of the volumeLiveBackup option:
API Response
Sample Response
{ "inventory": { "uuid": "6bd6608ecda63747b2471a02b42704d6", "volumeUuid": "1a0c6b2ca31a3b40b2c06a0f2ecb0849", "name": "Backup-1", "description": "volume backup", "size": 1.073741824E9, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error | 2.6.0 |
| inventory | VolumeBackupInventory | See inventory | 2.6.0 |
#error
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 2.6.0 |
| description | String | The brief description of the error. | 2.6.0 |
| details | String | The details about the error. | 2.6.0 |
| elaboration | String | The reserved field. Default value: null. | 2.6.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 2.6.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 2.6.0 |
#inventory
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The UUID of the volume backup. | 2.6.0 |
| volumeUuid | String | The UUID of the volume. | 2.6.0 |
| name | String | The name of the volume backup. | 2.6.0 |
| description | String | The detailed description of the backup. | 2.6.0 |
| type | String | The type of the volume. | 2.6.0 |
| state | String | The status of the backup. | 2.6.0 |
| status | String | The availability status of the backup. | 2.6.0 |
| size | Long | The size of the backup. | 2.6.0 |
| metadata | String | The metadata of the backup. | 2.6.0 |
| createDate | Timestamp | The time when the backup was created. | 2.6.0 |
| lastOpDate | Timestamp | The time when the backup was last modified. | 2.6.0 |
| backupStorageRefs | List | See backupStorageRefs | 2.6.0 |
#backupStorageRefs
| Name | Type | Description | Starting Version |
|---|---|---|---|
| volumeBackupUuid | String | The UUID of the volume backup. | 2.6.0 |
| backupStorageUuid | String | The UUID of the backup storage. | 2.6.0 |
| installPath | String | The storage path of the backup. | 2.6.0 |
| status | String | The status of the backup in the backup storage. | 2.6.0 |
| createDate | Timestamp | The time when the backup was created. | 2.6.0 |
| lastOpDate | Timestamp | The time when the backup was last modified. | 2.6.0 |
SDK Sample
Java SDK
CreateVolumeBackupAction action = new CreateVolumeBackupAction(); action.volumeUuid = "ec7196ba2d993236aceddd9b31f5d19b"; action.backupStorageUuid = "1c4b0a3a24533c4faa9b156a0ef98fdf"; action.name = "backup-1"; action.description = "a critical volume backup"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateVolumeBackupAction.Result res = action.call();Python SDK
CreateVolumeBackupAction action = CreateVolumeBackupAction() action.volumeUuid = "ec7196ba2d993236aceddd9b31f5d19b" action.backupStorageUuid = "1c4b0a3a24533c4faa9b156a0ef98fdf" action.name = "backup-1" action.description = "a critical volume backup" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateVolumeBackupAction.Result res = action.call()Next Chapter: Tag Operations