Operations

CreateVolumeBackup

Creates a volume backup. For example,

CreateVolumeBackup name=test volumeUuid=c675eb9b802b42248739c5a2a4330ee7 backupStorageUuid=3feb163a6a694a7f92b9636c4836e9fe

Name	Description	Optional	Starting Version
volumeUuid	The volume UUID.		2.6.0
backupStorageUuid	The backup storage UUID.		2.6.0
name	The resource name.		2.6.0
description	The detailed description of the resource.	Yes	2.6.0
volumeReadBandwidth	The volume read bandwidth.	Yes	3.1.0
volumeWriteBandwidth	The volume write bandwidth.	Yes	3.1.0
networkReadBandwidth	The network read bandwidth.	Yes	3.1.0
networkWriteBandwidth	The network write bandwidth.	Yes	3.1.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.6.0
timeout		Yes

Note:

When you create a volume backup in ZStack, 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
When you create a volume backup in ZStack, 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
When you create a volume backup in ZStack, 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

Deletes a volume backup. For example,

DeleteVolumeBackup uuid=c675eb9b802b42248739c5a2a4330ee7

Name	Description	Optional	Starting Version
uuid	The resource UUID.		2.6.0
backupStorageUuids	The backup storage UUID list.	Yes	2.6.0
deleteMode	The delete mode.	Yes	2.6.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	2.6.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	2.6.0
timeout		Yes

Queries a volume backup record. For example,

QueryVolumeBackup Uuid=c675eb9b802b42248739c5a2a4330ee7

Field	Inventory	Description	Starting Version
backupStorage	Backup Storage Inventory	The backup storage to which the volume backup belongs.	2.6.0
backupStorageRefs	Backup Storage Reference	The reference that is used to query the installation path of the backup storage.	2.6.0