DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

Backup Service (Plus)

Overview

Backup management integrates multiple disaster recovery technologies such as incremental backup and full backup that are suitable for multiple business scenarios. You can implement local backup and remote backup based on your business needs.

Backup Service is a separate feature module. To use this service, purchase both the Base License and the Plus License of Backup Service. The Plus License cannot be used independently.

Typical Backup Scenarios

Backup Service can be applied to the following three typical scenarios: local backup, remote backup, and Public Cloud backup.
Note: If you have the Tenant Management Plus license at the same time, the project members (project managers, project admins, and general project members) can perform local backup for VM instances, elastic baremetal instances, and data volumes in the project.
  • Local Backup

    A local ImageStore image storage can act as the Local Backup Server to store scheduled backup data of the local VM instances, elastic baremetal instances, data volumes, and management node databases. Meanwhile, the seamless switchover between the primary local backup server and the secondary local backup server is supported, which effectively ensures your business continuity.

    If your local data is mistakenly deleted, or data in the local primary storage is damaged, you can recover the backup data from the local backup server, as shown in Local Backup Scenario-1

    Figure 1. Local Backup Scenario-1


    If you encounter a disaster in your local data center, you can rely totally on your local backup server to rebuild your data center and recover your business, as shown in Local Backup Scenario-2.

    Figure 2. Local Backup Scenario-2


  • Remote Backup

    A storage server in a remote data center can act as the Remote Backup Server to store the scheduled backup data of the local VM instances, elastic baremetal instances, volumes, and databases. The backup data needs to be synchronized to the remote backup server from the local backup server.

    If your local data is mistakenly deleted, or data in the local primary storage is damaged, you can recover the backup data from the remote backup server, as shown in Remote Backup Scenario-1

    Figure 3. Remote Backup Scenario-1


    If you encounter a disaster in your data center, you can rely totally on your remote backup server to rebuild your data center and recover your business, as shown in Remote Backup Scenario-2.

    Figure 4. Remote Backup Scenario-2


  • Public Cloud Backup
    The storage server in the Public Cloud can act as the Public Cloud Backup Server to store the scheduled backup data of the local VM instances, volumes, and databases. The backup data can be synchronized to the Public Cloud backup server from the local backup server.
    Note: The Public Cloud backup feature does not apply to elastic baremetal instances.

    If your local data is mistakenly deleted, or data in the local primary storage is damaged, you can recover the backup data from the Public Cloud backup server, as shown in Public Cloud Backup Scenario-1.

    Figure 5. Public Cloud Backup Scenario-1


    If you encounter a disaster in your data center, you can rely totally on your Public Cloud backup server to rebuild your data center and recover your business, as shown in Public Cloud Backup Scenario-2.

    Figure 6. Public Cloud Backup Scenario-2


  • ZStack Cloud allows you to integrate 3rd-party backup services via CBT interfaces. For details, contact the official technical support.

Inventory

Volume Backup Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 2.6.0
name The name. For more information, see Resource Property. 2.6.0
description The description. For more information, see Resource Property. Yes 2.6.0
volumeUuid The volume UUID. 2.6.0
type The volume type. 2.6.0
state The state of the volume backup. 2.6.0
status The status of the volume backup. 2.6.0
size The size of the current volume backup. 2.6.0
metadata The related metadata of the volume backup. 2.6.0
backupStorageRefs The references of the backup storage installation path. 2.6.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 2.6.0
createDate The creation date. For more information, see Resource Property. 2.6.0
lastOpDate The last operation date. For more information, see Resource Property. 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

Sample

{
    "inventories": [
        {
            "backupStorageRefs": [
                {
                    "backupStorageUuid": "7ea14cfe51c847b8a1ae84e8a49ef933",
                    "createDate": "Jul 25, 2018 4:55:41 PM",
                    "installPath": "zstore://1e3d8590456041b8864454abac599132/eeb95535aa1669438e7ce1f8db4d90a104627c3f",
                    "lastOpDate": "Jul 25, 2018 4:55:41 PM",
                    "status": "Ready",
                    "volumeBackupUuid": "17aca6d09c0e4181a23ac7c70eb4ab9a"
                }
            ],
            "createDate": "Jul 25, 2018 4:55:37 PM",
            "lastOpDate": "Jul 25, 2018 4:55:37 PM",
            "metadata": "{"type":"Root","name":"ROOT-for-333","description":"Root volume for VM[uuid:7c3c2f94a39d46429166aa99657472e3]","vmName":"333","vmDescription":"","vmInstanceUuid":"7c3c2f94a39d46429166aa99657472e3","platform":"Linux","clusterUuid":"8ad9ebf4b7a043499751269b67fcecac","primaryStorageUuid":"79d056d0aeaf437398f612b8a1bff89f","cpuNum":1,"memorySize":536870912,"instanceOfferingUuid":"01f2228c7e1c4d0d9aa7db056320f94e","defaultL3NetworkUuid":"2341d7e6ef4544708cea0d4e9f6cda13","vmNics":[{"uuid":"e7e57aafb2a7410aa5f47cb881566def","vmInstanceUuid":"7c3c2f94a39d46429166aa99657472e3","usedIpUuid":"6a4383edb66232c0b1e34c9d0178450c","l3NetworkUuid":"2341d7e6ef4544708cea0d4e9f6cda13","ip":"172.20.118.6","mac":"fa:c2:f9:87:13:00","netmask":"255.255.0.0","gateway":"172.20.0.1","internalName":"vnic34.0","deviceId":0,"createDate":"Jul 25, 2018 12:37:21 PM","lastOpDate":"Jul 25, 2018 12:37:21 PM"}]}",
            "name": "2",
            "size": 32374784,
            "state": "Enabled",
            "status": "Ready",
            "type": "Root",
            "uuid": "17aca6d09c0e4181a23ac7c70eb4ab9a",
            "volumeUuid": "0e4fee174e6e4d04b3dc00f4bfc761f5"
        }
           ],
            "createDate": "Jul 25, 2018 4:55:51 PM",
            "lastOpDate": "Jul 25, 2018 4:55:51 PM",
            "metadata": "{"type":"Root","name":"ROOT-for-333","description":"Root volume for VM[uuid:7c3c2f94a39d46429166aa99657472e3]","vmName":"333","vmDescription":"","vmInstanceUuid":"7c3c2f94a39d46429166aa99657472e3","platform":"Linux","clusterUuid":"8ad9ebf4b7a043499751269b67fcecac","primaryStorageUuid":"79d056d0aeaf437398f612b8a1bff89f","cpuNum":1,"memorySize":536870912,"instanceOfferingUuid":"01f2228c7e1c4d0d9aa7db056320f94e","defaultL3NetworkUuid":"2341d7e6ef4544708cea0d4e9f6cda13","vmNics":[{"uuid":"e7e57aafb2a7410aa5f47cb881566def","vmInstanceUuid":"7c3c2f94a39d46429166aa99657472e3","usedIpUuid":"6a4383edb66232c0b1e34c9d0178450c","l3NetworkUuid":"2341d7e6ef4544708cea0d4e9f6cda13","ip":"172.20.118.6","mac":"fa:c2:f9:87:13:00","netmask":"255.255.0.0","gateway":"172.20.0.1","internalName":"vnic34.0","deviceId":0,"createDate":"Jul 25, 2018 12:37:21 PM","lastOpDate":"Jul 25, 2018 12:37:21 PM"}]}",
            "name": "3",
            "size": 32374784,
            "state": "Enabled",
            "status": "Ready",
            "type": "Root",
            "uuid": "fe6f225fafdd4c8eaf840a136b6e587f",
            "volumeUuid": "0e4fee174e6e4d04b3dc00f4bfc761f5"
        }
    ],
    "success": true
}

Database Backup Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.0.0
name The name. For more information, see Resource Property. 3.0.0
description The description. For more information, see Resource Property. Yes 3.0.0
state The state of the database backup. 3.0.0
status The status of the database backup. 3.0.0
size The size of the current database backup. 3.0.0
metadata The related metadata of the database backup. 3.0.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 3.0.0
createDate The creation date. For more information, see Resource Property. 3.0.0
lastOpDate The last operation date. For more information, see Resource Property. 3.0.0
userTags The user tags. The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0

Sample

{
    "inventories": [
        {
            "backupStorageRefs": [
                {
                    "backupStorageUuid": "dca2ed03807a4b2c9705ba9dcfefe2ff",
                    "createDate": "Sep 19, 2018 2:42:04 PM",
                    "databaseBackupUuid": "eed88906f8a145929d873fbe4f542264",
                    "installPath": "zstore://zsbak/8f8b91526b95a9d1157a99eee4de7b7b03446519",
                    "lastOpDate": "Sep 19, 2018 4:13:29 PM",
                    "status": "Ready"
                }
            ],
            "createDate": "Sep 19, 2018 2:42:02 PM",
            "lastOpDate": "Sep 19, 2018 2:42:02 PM",
            "metadata": "{"name":"tast1","version":"3.0.0","createdTime":"Sep 19, 2018 2:42:03 PM","md5":"6f3415a3a4c56c56f51ffd95f286fb7b"}",
            "name": "tast1",
            "size": 376991,
            "state": "Enabled",
            "status": "Ready",
            "uuid": "eed88906f8a145929d873fbe4f542264"
        }
    ],
    "success": true
}

Scheduler Job History Inventory

Name Description Optional Valid Value Starting Version
executeTime The execution time. 3.5.0
id 3.5.0
requestDump The job request. 3.5.0
resultDump The job result. 3.5.0
schedulerJobGroupUuid The UUID of the scheduled job group. 3.5.0
schedulerJobUuid The scheduled job UUID. 3.5.0
success 3.5.0
targetResourceUuid The target resource UUID. 3.5.0
triggerUuid The trigger UUID. 3.5.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 3.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.0

Scheduler Job Group Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.4.0
name The name. For more information, see Resource Property. 3.4.0
description The description. For more information, see Resource Property. Yes 3.4.0
state The state of the scheduled job group. Yes 3.4.0
jobData The job data. Yes 3.4.0
triggersUuid The trigger UUID. Yes 3.4.0
createDate The creation date. For more information, see Resource Property. 3.4.0
lastOpDate The last operation date. For more information, see Resource Property. 3.4.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
Sample
{
  "inventories": [
    {
      "uuid": "03dd26d45bb43bb094f3fdec29d78829",
      "name": "test",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

Operations

CreateVolumeBackup

Creates a volume backup. For example,
CreateVolumeBackup name=test volumeUuid=c675eb9b802b42248739c5a2a4330ee7 backupStorageUuid=3feb163a6a694a7f92b9636c4836e9fe

Parameters

Name Description Optional Valid Value 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 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
  • 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
  • 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

DeleteVolumeBackup

Deletes a volume backup. For example,
DeleteVolumeBackup uuid=c675eb9b802b42248739c5a2a4330ee7

Parameters

Name Description Optional Valid Value 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
handleDependency Optional. whether to handle dependency when deleting volume backup. Yes 4.7.11

QueryVolumeBackup

Queries a volume backup record. For example,
QueryVolumeBackup Uuid=c675eb9b802b42248739c5a2a4330ee7

Primitive Fields of Query

See Volume Backup Inventory.

Nested and Expanded Fields of Query

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

CreateDataVolumeTemplateFromVolumeBackup

Creates a data volume image from a volume backup. For example,
CreateDataVolumeTemplateFromVolumeBackup name=test backupUuid=fe6f225fafdd4c8eaf840a136b6e587f backupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

Parameters

Name Description Optional Valid Value Starting Version
backupUuid The volume backup 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
guestOsType The guest operating system type. Yes 2.6.0
platform The guest operating system platform. Yes
  • Linux
  • Windows
  • Other
  • Paravirtualization
  • WindowsVirtio
 2.6.0
architecture Yes 4.0.0
tagUuids The tag UUIDs. Yes 4.0.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

CreateRootVolumeTemplateFromVolumeBackup

Creates a root volume image from a volume backup. For example,
CreateRootVolumeTemplateFromVolumeBackup name=test backupUuid=fe6f225fafdd4c8eaf840a136b6e587f backupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

Parameters

Name Description Optional Valid Value Starting Version
backupUuid The volume backup 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
guestOsType The guest operating system type. Yes 2.6.0
platform The guest operating system platform. Yes
  • Linux
  • Windows
  • Other
  • Paravirtualization
  • WindowsVirtio
 2.6.0
architecture Yes
  • x86_64
  • aarch64
  • mips64el
 4.0.0
tagUuids The tag UUIDs. Yes 4.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 2.6.0
systemTags The system. For more information, see CreateSystemTag. Yes 2.6.0
timeout Yes

SyncVolumeBackup

Synchronizes a volume backup. For example,
SyncVolumeBackup imageStoreUuid=dfa5adc643d34dc88b78153deb918dd8

Parameters

Name Description Optional Valid Value Starting Version
imageStoreUuid The ImageStore UUID. 3.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.0
timeout Yes

RevertVolumeFromVolumeBackup

Removes a volume from a volume backup. For example,
RevertVolumeFromVolumeBackup uuid=8a996d1416ed44ccb183e24f46c34206

Parameters

Name Description Optional Valid Value Starting Version
uuid The volume backup UUID. 2.6.0
backupStrogeUuid The backup storage UUID. 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

RecoverBackupFromImageStoreBackupStorage

Recovers a volume backup from a ImageStore backup storage. For example,
RecoverBackupFromImageStoreBackupStorage uuid=8a996d1416ed44ccb183e24f46c34206 srcBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7 dstBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

Parameters

Name Description Optional Valid Value Starting Version
uuid The volume backup UUID. 2.6.0
srcBackupStorageUuid The UUID of the source backup storage. 2.6.0
dstBackupStorageUuid The UUID of the destination backup storage UUID. 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

SyncBackupFromImageStoreBackupStorage

Synchronizes a volume backup to a backup storage. For example,
SyncBackupFromImageStoreBackupStorage uuid=8a996d1416ed44ccb183e24f46c34206 srcBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7 dstBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

Parameters

Name Description Optional Valid Value Starting Value
uuid The volume backup UUID. 2.6.0
srcBackupStorageUuid The UUID of the source backup storage. 2.6.0
dstBackupStorageUuid The UUID of the destination backup storage UUID. 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

CreateVmBackup

Creates a VM backup. For example,
CreateVmBackup rootVolumeUuid=ae62268e5ba7491face04a44103e3188 backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff name=VmBackup

Parameters

Name Description Optional Valid Value Starting Version
rootVolumeUuid The root volume UUID. 3.0.0
backupStorageUuid The backup storage UUID. 3.0.0
name The resource name. 3.0.0
description The detailed description of the resource. Yes 3.0.0
resourceUuid Yes 3.0.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 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes
Note:
  • When you create a VM backup in ZStack Cloud, the data of the VM instance in a host will be backed up to an ImageStore backup storage. The data exchange in this process will use the backup network. Note that 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 VM backup in ZStack Cloud, you can specify how to back up the VM instance 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 VM backup in ZStack Cloud, you can configure the concurrency level for the VM backup by adding the volumeLiveBackup option to SystemTags.
    • Format of the volumeLiveBackup option: volumeLiveBackup::parallelismDegree::$NUMBER
    • Example: volumeLiveBackup::parallelismDegree::1

SyncVmBackup

Synchronizes a VM backup. For example,
SyncVmBackup imageStoreUuid=dfa5adc643d34dc88b78153deb918dd8

Parameters

Name Description Optional Valid Value Starting Version
imageStoreUuid The backup storage UUID. 3.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.0
timeout Yes

DeleteVmBackup

Deletes a VM backup. For example,
DeleteVmBackup groupUuid=c6c4e6532117404b88b34d6a92f9916a

Parameters

Name Description Optional Valid Value Starting Version
groupUuid The backup group UUID. 3.0.0
backupStorageUuids The backup storage UUID list. Yes 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

RevertVmFromVmBackup

Reverts a VM instance from a VM backup. For example,
RevertVmFromVmBackup groupUuid=6408192a514a45b59bd695cb3440435f

Parameters

Name Description Optional Valid Value Starting Version
groupUuid The backup group UUID. 3.0.0
backupStorageUuid The backup storage UUID. Yes 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

CreateVmFromVmBackup

Creates a VM instance from a VM backup. For example,
CreateVmFromVmBackup name=VM-test groupUuid=6408192a514a45b59bd695cb3440435f instanceOfferingUuid=feba03817e0e326d827ebdb436786bad

Parameters

Name Description Optional Valid Value Starting Version
name The resource name.
groupUuid The UUID of the VM backup group.
backupStorageUuid The backup storage UUID. Yes
instanceOfferingUuid The instance offering UUID.
l3NetworkUuids The L3 network UUID list. Yes
type The VM instance type. Yes
zoneUuid The zone UUID. Yes
clusterUuid The cluster UUID. Yes
hostUuid The host UUID. Yes
primaryStorageUuidForRootVolume The UUID of the root volume primary storage. Yes
primaryStorageUuidForDataVolume The UUID of the data volume primary storage. Yes
description The detailed description of the resource. Yes
rootVolumeSystemTags The system tags of the root volume. Yes
dataVolumeSystemTags The system tags of the data volume. Yes
defaultL3NetworkUuid The UUID of the default L3 network. Yes
resourceUuid Yes
userTags The user tags. For more information, see CreateUserTag. Yes
systemTags The system tags. For more information, see CreateSystemTag. Yes
strategy The VM creation strategy. Yes
  • InstantStart
  • JustCreate
  • CreateStopped
 5.1.0
timeout Yes
Note:
  • When you create a VM instance from a VM backup, you can specify the volume provisioning strategy by adding the volumeProvisioningStrategy option to SystemTags. The SystemTag is passed by using the rootVolumeSystemTags parameter.
    • Format of the volumeProvisioningStrategy option: volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
    • Example: volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning

CreateVmFromVolumeBackup

Creates a VM instance from a volume backup. For example,
CreateVmFromVolumeBackup name=VM-test backupUuid=6408192a514a45b59bd695cb3440435f instanceOfferingUuid=feba03817e0e326d827ebdb436786bad l3NetworkUuids=[87b522f02ef83627bcab5e427ba2d5e6]

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 5.1.0
backupUuid The backup UUID. 5.1.0
backupStorageUuid The backup storage UUID. Yes 5.1.0
instanceOfferingUuid The instance offering UUID. 5.1.0
l3NetworkUuids The L3 network UUID list. 5.1.0
type The VM instance type Yes 5.1.0
zoneUuid The zone UUID. Yes 5.1.0
clusterUuid The cluster UUID. Yes 5.1.0
hostUuid The host UUID. Yes 5.1.0
primaryStorageUuidForRootVolume The UUID of the primary storage which the root volume resides on. Yes 5.1.0
description The description of the resource. Yes 5.1.0
rootVolumeSystemTags The system tag of the root volume. Yes 5.1.0
defaultL3NetworkUuid The UUID of the default L3 network. Yes 5.1.0
resourceUuid The resource UUID. Yes 5.1.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.1.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.1.0
tagUuids The tag UUID list. Yes 5.1.0
strategy The VM creation strategy. Yes
  • InstantStart
  • JustCreate
  • CreateStopped
 5.1.0
timeout Yes
Note:
  • When you create a VM instance from a VM backup, you can specify the volume provisioning strategy by adding the volumeProvisioningStrategy option to SystemTags. The SystemTag is passed by using the rootVolumeSystemTags parameter.
    • Format of the volumeProvisioningStrategy option: volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
    • Example: volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning

RecoverVmBackupFromImageStoreBackupStorage

Recovers a VM backup from a standby ImageStore backup storage. For example,
RecoverVmBackupFromImageStoreBackupStorage groupUuid=6408192a514a45b59bd695cb3440435f srcBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff dstBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

Parameters

Name Description Optional Valid Value Starting Version
groupUuid The backup group UUID. 3.0.0
srcBackupStorageUuid The UUID of the local backup storage. 3.0.0
dstBackupStorageUuid The UUID of the standby backup storage. 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

SyncVmBackupFromImageStoreBackupStorage

Synchronizes a VM backup to a standby ImageStore backup storage. For example,
SyncVmBackupFromImageStoreBackupStorage groupUuid=6408192a514a45b59bd695cb3440435f srcBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff dstBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

Parameters

Name Description Optional Valid Value Starting Version
groupUuid The backup group UUID. 3.0.0
srcBackupStorageUuid The UUID of the local backup storage. 3.0.0
dstBackupStorageUuid The UUID of the standby backup storage. 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

CreateDatabaseBackup

Creates a database backup. For example,
CreateDatabaseBackup name=database1 backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 3.0.0
backupStorageUuid The backup storage UUID. 3.0.0
description The detailed description of the resource. Yes 3.0.0
resourceUuid Yes 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

DeleteDatabaseBackup

Deletes a database backup. For example,
DeleteDatabaseBackup uuid=d7bb0605999d4d8983e841810b846f57

Parameters

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

QueryDatabaseBackup

Queries a database backup. For example,
QueryDatabaseBackup

Primitive Fields of Query

See Database Backup Inventory.

Nested and Expanded Fields of Query

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

SyncDatabaseBackup

Synchronizes a database backup. For example,
SyncDatabaseBackup imageStoreUuid=f8f76255778e4c8cbf33eb861e51e690

Parameters

Name Description Optional Valid Value Starting Version
imageStoreUuid The backup storage UUID. 3.2.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.2.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.2.0
timeout Yes

RecoverDatabaseFromBackup

Recovers a database from a database backup. For example,
RecoverDatabaseFromBackup mysqlRootPassword=cloud.mysql.password

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. Yes 3.0.0
backupStorageUrl The backup storage URL. Yes 3.0.0
backupInstallPath The installation path of the database backup. Yes 3.0.0
mysqlRootPassword The root password of the MySQL database. 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

ExportDatabaseBackupFromBackupStorage

Exports a database backup from a backup storage. For example,
ExportDatabaseBackupFromBackupStorage databaseBackupUuid=eed88906f8a145929d873fbe4f542264 backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

Parameters

Name Description Optional Valid Value Starting Version
backupStorageUuid The backup storage UUID. 3.0.0
databaseBackupUuid The database backup UUID. 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

GetDatabaseBackupFromImageStore

Obtains information about a database backup from a backup storage. For example,
GetDatabaseBackupFromImageStore url=/Cloud_bs

Parameters

Name Description Optional Valid Value Starting Version
url The backup storage URL. 3.0.0
registryPort The access port of the backup storage. Yes 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

DeleteExportedDatabaseBackupFromBackupStorage

Deletes an exported database backup from a backup storage. For example,
DeleteExportedDatabaseBackupFromBackupStorage backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff databaseBackupUuid=eed88906f8a145929d873fbe4f542264

Parameters

Name Description Optional Valid Value Starting Version
backupStorageUuid The backup storage UUID. 3.0.0
databaseBackupUuid The database backup UUID. 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

SyncDatabaseBackupFromImageStoreBackupStorage

Synchronizes a database backup to a standby backup storage. For example,
SyncDatabaseBackupFromImageStoreBackupStorage srcBackupStorageUuid=eed88906f8a145929d873fbe4f542264 uuid=eed88906f8a145929d873fbe4f542264 dstBackupStorageUuid=eed88906f8a145929d873fbe4f542264

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 3.0.0
srcBackupStorageUuid 3.0.0
dstBackupStorageUuid 3.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.0.0
timeout Yes

AddSchedulerJobGroupToSchedulerTrigger

Adds a scheduled job group to a scheduler trigger. For example,
AddSchedulerJobGroupToSchedulerTrigger schedulerJobGroupUuid=ec8d2952f8f13747bbbf24f93585a63d schedulerTriggerUuid=4b5bc56b58623324afe0a57951a96064

Parameters

Name Description Optional Valid Value Starting Version
schedulerJobGroupUuid The UUID of the scheduled job group. 3.4.0
schedulerTriggerUuid The scheduler trigger UUID. 3.4.0
triggerNow Whether the trigger works immediately. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

RemoveSchedulerJobGroupFromSchedulerTrigger

Removes a scheduled job group from a scheduler trigger. For example,
RemoveSchedulerJobGroupFromSchedulerTrigger schedulerJobGroupUuid=ec8d2952f8f13747bbbf24f93585a63d schedulerTriggerUuid=4b5bc56b58623324afe0a57951a96064

Parameters

Name Description Optional Valid Value Starting Version
schedulerJobGroupUuid The UUID of the scheduled job group. 3.4.0
schedulerTriggerUuid The scheduler trigger UUID. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

RunSchedulerTrigger

Runs a scheduler trigger. For example,
RunSchedulerTrigger uuid=8cd63a3dc09e49f0a99512f5f75a249c

Parameters

Name Description Optional Valid Value Starting Version
uuid The scheduler UUID. 3.5.0
jobUuids The job UUID of the optional trigger. Yes 3.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.0
timeout Yes

CreateSchedulerJobGroup

Creates a scheduled job group. For example,
CreateSchedulerJobGroup name=test type=startVm

Parameters

Name Description Optional Valid Value Starting Version
name The resource name. 3.4.0
description The detailed description of the resource. Yes 3.4.0
type The scheduled job type. Yes
  • startVm
  • stopVm
  • rebootVm
  • volumeSnapshot
  • volumeBackup
  • vmBackup
  • databaseBackup
  • runAutoScalingGroup
  • addIAM2ProjectLoginExpired
  • cancleIAM2ProjectLoginExpired
 4.3.0
parameters The parameters of the scheduled job group. Yes 3.4.0
resourceUuid The resource UUID. Yes 3.4.0
tagUuids The tag UUID list. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

DeleteSchedulerJobGroup

Deletes a scheduled job group. For example,
DeleteSchedulerJobGroup uuid=dca2ed03807a4b2c9705ba9dcfefe2ff

Parameters

Name Description Optional Valid Value Starting Version
uuid The scheduled job group UUID. 3.4.0
deleteMode The delete mode. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

UpdateSchedulerJobGroup

Updates a scheduled job group. For example,
UpdateSchedulerJobGroup uuid=dca2ed03807a4b2c9705ba9dcfefe2ff

Parameters

Name Description Optional Valid Value Starting Version
uuid The scheduled job group UUID. 3.4.0
name The resource name. Yes 3.4.0
description The detailed description of the resource. Yes 3.4.0
state The state. Yes
  • Enable
  • Disable
 3.4.0
parameters The parameters of the scheduled job group. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

QuerySchedulerJobGroup

Queries a scheduled job group. For example,
QuerySchedulerJobGroup

Primitive Fields of Query

See Scheduler Job Group Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
trigger Trigger Inventory The trigger to which a scheduled job is added. 3.4.0

AddSchedulerJobsToSchedulerJobGroup

Adds a scheduled job to a scheduled job group. For example,
AddSchedulerJobsToSchedulerJobGroup schedulerJobGroupUuid=c6c4e6532117404b88b34d6a92f9916a schedulerJobUuids=8b2e6f64e2404e48a07269487af2f587

Parameters

Name Description Optional Valid Value Starting Version
schedulerJobGroupUuid The UUID of the scheduled job group. 3.4.0
schedulerJobUuids The scheduled job UUID. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

RemoveSchedulerJobsFromSchedulerJobGroup

Removes a scheduled job from a scheduled job group. For example,
RemoveSchedulerJobsFromSchedulerJobGroup schedulerJobGroupUuid=c6c4e6532117404b88b34d6a92f9916a schedulerJobUuids=8b2e6f64e2404e48a07269487af2f587

Parameters

Name Description Optional Valid Value Starting Version
schedulerJobGroupUuid The UUID of the scheduled job group. 3.4.0
schedulerJobUuids The scheduled job UUID. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

QuerySchedulerJobHistory

Queries a scheduled job record. For example,
QuerySchedulerJobHistory

Primitive Fields of Query

See Scheduler Job History Inventory.

GetSchedulerExecutionReport

Obtains the execution report of a scheduled job. For example,
GetSchedulerExecutionReport startTime=1.5856704E12 intervalTimeUnit=Month range=4.0 schedulerJobTypes=vmBackup

Parameters

Name Description Optional Valid Value Starting Version
startTime The start time of the report. 3.9.0
intervalTimeUnit The unit of the interval.
  • Hour
  • Month
 3.9.0
range The time range of the report. 3.9.0
schedulerJobTypes The type of the scheduled job. 3.9.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.9.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.9.0
timeout Yes

Tags

You can create a user tag on an image by using resourceType=ImageVO. For example,
CreateUserTag resourceType=ImageVO tag=golden-ResourceStack
resourceUuid=8a996d1416ed44ccb183e24f46c34206
PreviousCapacity ManagementNextCBT Task
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center