文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›CLI命令使用手册ZCF
文档目录

灾备服务（Plus）

概述

灾备服务：云主机数据在线备份到备份服务器，支持本地，跨地域和混合云多种备份场景，数据更可靠 。

灾备服务以单独的功能模块形式提供，需提前购买灾备服务模块许可证，且需在购买云平台许可证基础上使用，不可单独使用。

应用场景

灾备服务模块提供本地灾备、异地灾备、公有云灾备三种典型灾备场景。
Note: 若同时拥有租户管理模块许可证，租户管理中的项目成员（项目负责人/项目管理员/普通项目成员）支持对项目中的云主机/云盘资源进行本地灾备。
  • 本地灾备：

    支持将本地部署的镜像仓库作为本地备份服务器，用于存放本地云主机/云盘/管理节点数据库（简称数据库）的定时备份数据。同时本地备份服务器支持主备无缝切换，有效保障业务连续性。

    当发生本地数据误删，或本地主存储中数据损坏等情况，可将本地备份服务器中的备份数据还原至本地。

    如图 1所示：
    图 1. 本地灾备场景1


    当本地数据中心发生灾难时，完全可依赖本地备份服务器重建数据中心并恢复业务。

    如图 2所示：
    图 2. 本地灾备场景2


  • 异地灾备：

    支持将异地机房的存储服务器作为异地备份服务器，用于存放本地云主机/云盘/云平台数据库的定时备份数据。备份数据需通过本地备份服务器同步至异地备份服务器。

    当发生本地数据误删，或本地主存储中数据损坏等情况，可将异地备份服务器中的备份数据还原至本地。

    如图 3所示：
    图 3. 异地灾备场景1


    当本地数据中心发生灾难时，完全可依赖异地备份服务器重建数据中心并恢复业务。

    如图 4所示：
    图 4. 异地灾备场景2


  • 公有云灾备：

    支持将公有云上的存储服务器作为公有云备份服务器，用于存放本地云主机/云盘/云平台数据库的定时备份数据。备份数据需通过本地备份服务器同步至公有云备份服务器。

    当发生本地数据误删，或本地主存储中数据损坏等情况，可将公有云备份服务器中的备份数据还原至本地。

    如图 5所示：
    图 5. 公有云灾备场景1

    当本地数据中心发生灾难时，完全可依赖公有云备份服务器重建数据中心并恢复业务。

    如图 6所示：
    图 6. 公有云灾备场景2


清单

云盘备份清单（VolumeBackup inventory）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.6.0
name 请参见 资源属性 2.6.0
description 请参见 资源属性 是 2.6.0
volumeUuid 云盘UUID 2.6.0
type 云盘的类型 2.6.0
state 云盘备份的启用状态 2.6.0
status 云盘备份的状态 2.6.0
size 当前云盘备份的大小 2.6.0
metadata 云盘备份相关元数据 2.6.0
backupStorageRefs 镜像服务器安装路径的引用 2.6.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 2.6.0
createDate 请参见 资源属性 2.6.0
lastOpDate 请参见 资源属性 2.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0

示例

{
    "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
}

数据库备份清单（DatabaseBackup inventory）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.0.0
name 请参见 资源属性 3.0.0
description 请参见 资源属性 是 3.0.0
state 数据库备份的启用状态 3.0.0
status 数据库备份的状态 3.0.0
size 当前数据库备份的大小 3.0.0
metadata 数据库备份相关元数据 3.0.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.0.0
createDate 请参见 资源属性 3.0.0
lastOpDate 请参见 资源属性 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0

示例

{
    "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
}

定时任务记录清单（SchedulerJobHistory inventory）

名字 描述 可选的 可选的参数值 起始支持版本
executeTime 执行时间 3.5.0
id 3.5.0
requestDump 任务请求 3.5.0
resultDump 任务结果 3.5.0
schedulerJobGroupUuid 定时任务组UUID 3.5.0
schedulerJobUuid 定时任务UUID 3.5.0
success 3.5.0
targetResourceUuid 目标资源UUID 3.5.0
triggerUuid 定时器UUID 3.5.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.5.0

定时任务组清单(SchedulerJobGroup Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.4.0
name 请参见 资源属性 3.4.0
description 请参见 资源属性 是 3.4.0
state 定时任务组的状态 是 3.4.0
jobData 任务参数 是 3.4.0
triggersUuid 触发器UUID 是 3.4.0
createDate 请参见 资源属性 3.4.0
lastOpDate 请参见 资源属性 3.4.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
示例
{
  "inventories": [
    {
      "uuid": "03dd26d45bb43bb094f3fdec29d78829",
      "name": "test",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

操作（Operations）

创建云盘备份(CreateVolumeBackup)

用户可以使用CreateVolumeBackup创建云盘备份。 例如：
CreateVolumeBackup name=test volumeUuid=c675eb9b802b42248739c5a2a4330ee7 backupStorageUuid=3feb163a6a694a7f92b9636c4836e9fe

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
volumeUuid 云盘UUID 2.6.0
backupStorageUuid 镜像存储UUID 2.6.0
name 资源名称 2.6.0
description 资源的详细描述 是 2.6.0
volumeReadBandwidth 云盘读取带宽 是 3.1.0
volumeWriteBandwidth 云盘写入带宽 是 3.1.0
networkReadBandwidth 下行网络带宽 是 3.1.0
networkWriteBandwidth 上行网络带宽 是 3.1.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
timeout 是
Note:
  • ZStack Cloud创建云盘备份时物理机到镜像仓库走备份网络，SystemTags增加backupnetwork选项。
    • 选项格式为：backup::network::cidr::CIDR
    • 例如：backup::network::cidr::10.0.0.0/8
  • ZStack Cloud创建云盘备份时设置备份数据到镜像服务器的传输方式，SystemTags增加fsInfo选项。
    • 选项格式为：fsInfo::type::$TYPE::url::$URL::options::$OPTIONS
    • 例如：fsInfo::type::nfs::url::172.32.1.119:/nas/nfs2::options::nolock,vers=3,rsize=32768,wsize=32768
  • ZStack Cloud创建云盘备份时设置备份并发度，SystemTags增加volumeLiveBackup选项。
    • 选项格式为：volumeLiveBackup::parallelismDegree::$NUMBER
    • 例如：volumeLiveBackup::parallelismDegree::1

删除云盘备份(DeleteVolumeBackup)

用户可以使用DeleteVolumeBackup删除云盘备份。 例如：
DeleteVolumeBackup uuid=c675eb9b802b42248739c5a2a4330ee7

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 2.6.0
backupStorageUuids 镜像服务器uuid列表 是 2.6.0
deleteMode 删除模式 是 2.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
handleDependency 数据库删除策略考虑依赖关系 是 4.7.11

查询云盘备份记录(QueryVolumeBackup)

管理员可以使用QueryVolumeBackup查询云盘备份记录。例如：
QueryVolumeBackup Uuid=c675eb9b802b42248739c5a2a4330ee7

原生域查询（Primitive Fields of Query）

请参见云盘备份清单（VolumeBackup inventory）。

嵌套和扩展域查询（Nested And Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
backupStorage backup storage inventory 云盘备份所在的镜像服务器 2.6.0
backupStorageRefs backup storage reference 用来查询镜像服务器安装路径的引用 2.6.0

从云盘备份创建数据盘镜像(CreateDataVolumeTemplateFromVolumeBackup)

用户可以使用CreateDataVolumeTemplateFromVolumeBackup从云盘备份创建数据盘镜像。 例如：
CreateDataVolumeTemplateFromVolumeBackup name=test backupUuid=fe6f225fafdd4c8eaf840a136b6e587f backupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
backupUuid 云盘备份uuid 2.6.0
backupStorageUuid 镜像存储UUID 2.6.0
name 资源名称 2.6.0
description 资源的详细描述 是 2.6.0
guestOsType 宿主机操作系统类型 是 2.6.0
platform 宿主机平台类型 是
  • Linux
  • Windows
  • Other
  • Paravirtualization
  • WindowsVirtio
 2.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
architecture 是 4.0.0
tagUuids 标签UUID列表 是 4.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
timeout 是

从云盘备份创建根云盘镜像(CreateRootVolumeTemplateFromVolumeBackup)

用户可以使用CreateRootVolumeTemplateFromVolumeBackup从云盘备份创建根云盘镜像。 例如：
CreateRootVolumeTemplateFromVolumeBackup name=test backupUuid=fe6f225fafdd4c8eaf840a136b6e587f backupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
backupUuid 云盘备份uuid 2.6.0
backupStorageUuid 镜像存储UUID 2.6.0
name 资源名称 2.6.0
description 资源的详细描述 是 2.6.0
guestOsType 宿主机操作系统类型 是 2.6.0
platform 宿主机平台类型 是
  • Linux
  • Windows
  • Other
  • Paravirtualization
  • WindowsVirtio
 2.6.0
architecture 是
  • x86_64
  • aarch64
  • mips64el
 4.0.0
tagUuids 标签UUID列表 是 4.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
timeout 是

扫描云盘备份(SyncVolumeBackup)

用户可以使用SyncVolumeBackup扫描云盘备份。 例如：
SyncVolumeBackup imageStoreUuid=dfa5adc643d34dc88b78153deb918dd8

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
imageStoreUuid 备份服务器UUID 3.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.5.0
timeout 是

从云盘备份恢复云盘(RevertVolumeFromVolumeBackup)

用户可以使用RevertVolumeFromVolumeBackup从云盘备份恢复云盘。 例如：
RevertVolumeFromVolumeBackup uuid=8a996d1416ed44ccb183e24f46c34206

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 云盘备份的UUID，唯一标示该资源 2.6.0
backupStrogeUuid 镜像服务器uuid 是 2.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
timeout 是

从目标镜像服务器还原云盘备份(RecoverBackupFromImageStoreBackupStorage)

用户可以使用RecoverBackupFromImageStoreBackupStorage从目标镜像服务器还原云盘备份。 例如：
RecoverBackupFromImageStoreBackupStorage uuid=8a996d1416ed44ccb183e24f46c34206 srcBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7 dstBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 云盘备份的UUID，唯一标示该资源 2.6.0
srcBackupStorageUuid 接收恢复云盘的镜像服务器uuid 2.6.0
dstBackupStorageUuid 恢复镜像服务器uuid 2.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
timeout 是

将云盘备份同步至目标镜像服务器(SyncBackupFromImageStoreBackupStorage)

用户可以使用SyncBackupFromImageStoreBackupStorage将云盘备份同步至目标镜像服务器。 例如：
SyncBackupFromImageStoreBackupStorage uuid=8a996d1416ed44ccb183e24f46c34206 srcBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7 dstBackupStorageUuid=c675eb9b802b42248739c5a2a4330ee7

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 云盘备份的UUID，唯一标示该资源 2.6.0
srcBackupStorageUuid 源镜像服务器 2.6.0
dstBackupStorageUuid 目标镜像服务器 2.6.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 2.6.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 2.6.0
timeout 是

创建云主机备份(CreateVmBackup)

用户可以使用CreateVmBackup创建云主机备份。 例如：
CreateVmBackup rootVolumeUuid=ae62268e5ba7491face04a44103e3188 backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff name=VmBackup

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
rootVolumeUuid 根云盘UUID 3.0.0
backupStorageUuid 镜像存储UUID 3.0.0
name 资源名称 3.0.0
description 资源的详细描述 是 3.0.0
resourceUuid 是 3.0.0
volumeReadBandwidth 云盘读取带宽 是 3.1.0
volumeWriteBandwidth 云盘写入带宽 是 3.1.0
networkReadBandwidth 下行网络带宽 是 3.1.0
networkWriteBandwidth 上行网络带宽 是 3.1.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是
Note:
  • ZStack Cloud创建云主机备份时物理机到镜像仓库走备份网络，SystemTags增加backupnetwork选项。
    • 选项格式为：backup::network::cidr::CIDR
    • 例如：backup::network::cidr::10.0.0.0/8
  • ZStack Cloud创建云主机备份时设置设置备份数据到镜像服务器的传输方式，SystemTags增加fsInfo选项。
    • 选项格式为：fsInfo::type::$TYPE::url::$URL::options::$OPTIONS
    • 例如：fsInfo::type::nfs::url::172.32.1.119:/nas/nfs2::options::nolock,vers=3,rsize=32768,wsize=32768
  • ZStack Cloud创建云主机备份时设置备份并发度，SystemTags增加volumeLiveBackup选项。
    • 选项格式为：volumeLiveBackup::parallelismDegree::$NUMBER
    • 例如：volumeLiveBackup::parallelismDegree::1

扫描云主机备份(SyncVmBackup)

用户可以使用SyncVmBackup扫描云主机备份。 例如：
SyncVmBackup imageStoreUuid=dfa5adc643d34dc88b78153deb918dd8

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
imageStoreUuid 备份服务器UUID 3.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.5.0
timeout 是

删除云主机备份(DeleteVmBackup)

用户可以使用DeleteVmBackup删除云主机备份。 例如：
DeleteVmBackup groupUuid=c6c4e6532117404b88b34d6a92f9916a

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
groupUuid 备份组uuid 3.0.0
backupStorageUuids 镜像服务器uuid列表 是 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

从云主机备份恢复云主机(RevertVmFromVmBackup)

用户可以使用RevertVmFromVmBackup从云主机备份恢复云主机。 例如：
RevertVmFromVmBackup groupUuid=6408192a514a45b59bd695cb3440435f

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
groupUuid 备份组uuid 3.0.0
backupStorageUuid 镜像存储UUID 是 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

从云主机备份创建云主机(CreateVmFromVmBackup)

用户可以使用CreateVmFromVmBackup从云主机备份创建云主机。 例如：
CreateVmFromVmBackup name=VM-test groupUuid=6408192a514a45b59bd695cb3440435f instanceOfferingUuid=feba03817e0e326d827ebdb436786bad

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.0.0
groupUuid 云主机备份组UUID 3.0.0
backupStorageUuid 镜像存储UUID 是 0.6
instanceOfferingUuid 计算规格UUID 3.0.0
l3NetworkUuids 一组三层网络的UUID 3.0.0
vmNicParams 网卡信息 是 4.7.0
type 云主机类型 是 3.0.0
zoneUuid 区域UUID 是 3.0.0
clusterUuid 集群UUID 是 3.0.0
hostUuid 物理机UUID 是 3.0.0
primaryStorageUuidForRootVolume 根云盘主存储UUID 是 3.0.0
primaryStorageUuidForDataVolume 数据盘主存储UUID 是
description 资源的详细描述 是
rootVolumeSystemTags 根云盘系统标签 是
dataVolumeSystemTags 数据盘系统标签 是
defaultL3NetworkUuid 默认三层网络的UUID 是
resourceUuid 是
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是
tagUuids 标签UUID列表 是 3.4.0
strategy 云主机创建策略 是
  • InstantStart
  • JustCreate
  • CreateStopped
 5.1.0
timeout 是
Note:
  • 从云主机备份创建云主机时支持指定云盘置备方式，SystemTags增加volumeProvisioningStrategy选项，使用 rootVolumeSystemTags参数来传递 SystemTag。
    • 选项格式为：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
    • 例如：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning

从云盘备份创建云主机(CreateVmFromVolumeBackup)

用户可以使用CreateVmFromVolumeBackup从云盘备份创建云主机。 例如：
CreateVmFromVolumeBackup name=VM-test nackupUuid=6408192a514a45b59bd695cb3440435f instanceOfferingUuid=feba03817e0e326d827ebdb436786bad l3NetworkUuids=[87b522f02ef83627bcab5e427ba2d5e6]

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 5.1.0
backupUuid 备份UUID 5.1.0
backupStorageUuid 镜像存储UUID 是 5.1.0
instanceOfferingUuid 计算规格UUID 5.1.0
l3NetworkUuids 一组三层网络的UUID 5.1.0
type 云主机类型 是 5.1.0
zoneUuid 区域UUID 是 5.1.0
clusterUuid 集群UUID 是 5.1.0
hostUuid 物理机UUID 是 5.1.0
primaryStorageUuidForRootVolume 根云盘主存储UUID 是 5.1.0
description 资源的详细描述 是 5.1.0
rootVolumeSystemTags 根云盘系统标签 是 5.1.0
defaultL3NetworkUuid 默认三层网络的UUID 是 5.1.0
resourceUuid 是 5.1.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 5.1.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 5.1.0
tagUuids 标签UUID列表 是 5.1.0
strategy 云主机创建策略 是
  • InstantStart
  • JustCreate
  • CreateStopped
 5.1.0
timeout 是

从备份镜像仓库还原云主机备份(RecoverVmBackupFromImageStoreBackupStorage)

用户可以使用RecoverVmBackupFromImageStoreBackupStorage从备份镜像仓库还原云主机备份。 例如：
RecoverVmBackupFromImageStoreBackupStorage groupUuid=6408192a514a45b59bd695cb3440435f srcBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff dstBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
groupUuid 备份组uuid 3.0.0
srcBackupStorageUuid 本地镜像服务器 3.0.0
dstBackupStorageUuid 备份镜像服务器 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

同步云主机备份至备份镜像服务器(SyncVmBackupFromImageStoreBackupStorage)

用户可以使用SyncVmBackupFromImageStoreBackupStorage同步云主机备份至备份镜像服务器。 例如：
SyncVmBackupFromImageStoreBackupStorage groupUuid=6408192a514a45b59bd695cb3440435f srcBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff dstBackupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
groupUuid 备份组uuid 3.0.0
srcBackupStorageUuid 本地镜像服务器 3.0.0
dstBackupStorageUuid 备份镜像服务器 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

创建数据库备份(CreateDatabaseBackup)

用户可以使用CreateDatabaseBackup创建数据库备份。例如：
CreateDatabaseBackup name=database1 backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.0.0
backupStorageUuid 镜像存储UUID 3.0.0
description 资源的详细描述 是 3.0.0
resourceUuid 是 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

删除数据库备份(DeleteDatabaseBackup)

用户可以使用DeleteDatabaseBackup来删除数据库备份。例如：
DeleteDatabaseBackup uuid=d7bb0605999d4d8983e841810b846f57

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.0.0
backupStorageUuids 镜像服务器UUID列表 是 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

查询数据库备份(QueryDatabaseBackup)

管理员可以使用QueryDatabaseBackup查询数据库备份。例如：
QueryDatabaseBackup

原生域查询（Primitive Fields of Query）

请参见 数据库备份清单（DatabaseBackup inventory）。

嵌套和扩展域查询（Nested And Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
backupStorage backup storage inventory 数据库备份所在的镜像服务器 3.0.0
backupStorageRefs backup storage reference 用来查询镜像服务器安装路径的引用 3.0.0

扫描数据库备份(SyncDatabaseBackup)

用户可以使用SyncDatabaseBackup同步数据库备份。例如：
SyncDatabaseBackup imageStoreUuid=f8f76255778e4c8cbf33eb861e51e690

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
imageStoreUuid 备份服务器UUID 3.2.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.2.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.2.0
timeout 是

从数据库备份还原数据库(RecoverDatabaseFromBackup)

用户可以使用RecoverDatabaseFromBackup从数据库备份还原数据库。例如：
RecoverDatabaseFromBackup mysqlRootPassword=cloud.mysql.password

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 是 3.0.0
backupStorageUrl 镜像服务器URL 是 3.0.0
backupInstallPath 数据库备份存储路径 是 3.0.0
mysqlRootPassword MYSQL数据库ROOT密码 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

从备份服务器导出数据库备份(ExportDatabaseBackupFromBackupStorage)

用户可以使用ExportDatabaseBackupFromBackupStorage从备份服务器导出数据库备份。例如：
ExportDatabaseBackupFromBackupStorage databaseBackupUuid=eed88906f8a145929d873fbe4f542264 backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
backupStorageUuid 镜像存储UUID 3.0.0
databaseBackupUuid 数据库备份UUID 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

获取备份服务器上的数据库备份信息(GetDatabaseBackupFromImageStore)

用户可以使用GetDatabaseBackupFromImageStore获取备份服务器上的数据库备份信息。例如：
GetDatabaseBackupFromImageStore url=/Cloud_bs

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
url 镜像服务器URL 3.0.0
registryPort 镜像仓库访问端口 是 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

删除导出的数据库备份(DeleteExportedDatabaseBackupFromBackupStorage)

用户可以使用DeleteExportedDatabaseBackupFromBackupStorage删除导出的数据库备份。例如：
DeleteExportedDatabaseBackupFromBackupStorage backupStorageUuid=dca2ed03807a4b2c9705ba9dcfefe2ff databaseBackupUuid=eed88906f8a145929d873fbe4f542264

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
backupStorageUuid 镜像存储UUID 3.0.0
databaseBackupUuid 镜像仓库访问端口 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

同步备份至备份服务器(SyncDatabaseBackupFromImageStoreBackupStorage)

用户可以使用SyncDatabaseBackupFromImageStoreBackupStorage同步数据库备份至备份服务器。例如：
SyncDatabaseBackupFromImageStoreBackupStorage srcBackupStorageUuid=eed88906f8a145929d873fbe4f542264 uuid=eed88906f8a145929d873fbe4f542264 dstBackupStorageUuid=eed88906f8a145929d873fbe4f542264

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID，唯一标示该资源 3.0.0
srcBackupStorageUuid 3.0.0
dstBackupStorageUuid 3.0.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.0.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.0.0
timeout 是

定时任务组绑定触发器(AddSchedulerJobGroupToSchedulerTrigger)

用户可以使用AddSchedulerJobGroupToSchedulerTrigger给定时任务组绑定触发器。 例如：
AddSchedulerJobGroupToSchedulerTrigger schedulerJobGroupUuid=ec8d2952f8f13747bbbf24f93585a63d schedulerTriggerUuid=4b5bc56b58623324afe0a57951a96064

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
schedulerJobGroupUuid 定时任务组UUID 3.4.0
schedulerTriggerUuid 触发器UUID 3.4.0
triggerNow 是否立即触发 是 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

定时任务组解绑触发器(RemoveSchedulerJobGroupFromSchedulerTrigger)

用户可以使用RemoveSchedulerJobGroupFromSchedulerTrigger给定时任务组解绑触发器。 例如：
RemoveSchedulerJobGroupFromSchedulerTrigger schedulerJobGroupUuid=ec8d2952f8f13747bbbf24f93585a63d schedulerTriggerUuid=4b5bc56b58623324afe0a57951a96064

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
schedulerJobGroupUuid 定时任务组UUID 3.4.0
schedulerTriggerUuid 触发器UUID 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

触发定时器(RunSchedulerTrigger)

用户可以使用RunSchedulerTrigger触发定时器。 例如：
RunSchedulerTrigger uuid=8cd63a3dc09e49f0a99512f5f75a249c

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 定时器UUID 3.5.0
jobUuids 可选触发的任务UUID 是 3.5.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.5.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.5.0
timeout 是

创建定时任务组(CreateSchedulerJobGroup)

用户可以使用CreateSchedulerJobGroup创建定时任务组。 例如：
CreateSchedulerJobGroup name=test type=startVm

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.4.0
description 资源的详细描述 是 3.4.0
type 定时任务的类型 是
  • startVm
  • stopVm
  • rebootVm
  • volumeSnapshot
  • volumeBackup
  • vmBackup
  • databaseBackup
  • runAutoScalingGroup
  • addIAM2ProjectLoginExpired
  • cancleIAM2ProjectLoginExpired
 4.3.0
parameters 定时任务参数 是 3.4.0
resourceUuid 资源UUID 是 3.4.0
tagUuids 标签UUID列表 是 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

删除定时任务组(DeleteSchedulerJobGroup)

用户可以使用DeleteSchedulerJobGroup删除定时任务组。 例如：
DeleteSchedulerJobGroup uuid=dca2ed03807a4b2c9705ba9dcfefe2ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 定时任务组的UUID，唯一标示该资源 3.4.0
deleteMode 删除模式 是 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

更新定时任务组(UpdateSchedulerJobGroup)

用户可以使用UpdateSchedulerJobGroup更新定时任务组。 例如：
UpdateSchedulerJobGroup uuid=dca2ed03807a4b2c9705ba9dcfefe2ff

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 定时任务组的UUID，唯一标示该资源 3.4.0
name 资源名称 是 3.4.0
description 资源的详细描述 是 3.4.0
state 状态 是
  • enable
  • disable
 3.4.0
parameters 定时任务组参数 是 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

查询定时任务组(QuerySchedulerJobGroup)

管理员可以使用QuerySchedulerJobGroup查询定时任务组。例如：
QuerySchedulerJobGroup uuid=03dd26d45bb43bb094f3fdec29d78829

原生域查询（Primitive Fields of Query）

请参见定时任务组清单(SchedulerJobGroup Inventory)。

嵌套和扩展域查询（Nested And Expanded Fields of Query）

域（Field） 清单（Inventory） 描述 起始支持版本
trigger trigger inventory 加载定时任务组的定时器 3.4.0

任务组添加任务(AddSchedulerJobsToSchedulerJobGroup)

用户可以使用AddSchedulerJobsToSchedulerJobGroup给任务组添加任务。 例如：
AddSchedulerJobsToSchedulerJobGroup schedulerJobGroupUuid=c6c4e6532117404b88b34d6a92f9916a schedulerJobUuids=8b2e6f64e2404e48a07269487af2f587

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
schedulerJobGroupUuid 定时任务组UUID 3.4.0
schedulerJobUuids 定时任务UUID列表 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

定时任务组移除定时任务(RemoveSchedulerJobsFromSchedulerJobGroup)

用户可以使用RemoveSchedulerJobsFromSchedulerJobGroup从定时任务组移除定时任务。 例如：
RemoveSchedulerJobsFromSchedulerJobGroup schedulerJobGroupUuid=c6c4e6532117404b88b34d6a92f9916a schedulerJobUuids=8b2e6f64e2404e48a07269487af2f587

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
schedulerJobGroupUuid 定时任务组UUID 3.4.0
schedulerJobUuids 定时任务列表 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.4.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.4.0
timeout 是

查询定时任务记录(QuerySchedulerJobHistory)

管理员可以使用QuerySchedulerJobHistory查询定时任务记录。例如：
QuerySchedulerJobHistory

原生域查询（Primitive Fields of Query）

请参见定时任务记录清单（SchedulerJobHistory inventory）。

获取定时任务执行报告(GetSchedulerExecutionReport)

用户可以使用GetSchedulerExecutionReport获取定时任务执行报告。 例如：
GetSchedulerExecutionReport startTime=1.5856704E12 intervalTimeUnit=Month range=4.0 schedulerJobTypes=vmBackup

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
startTime 报告开始时间 3.9.0
intervalTimeUnit 间隔时间单位
  • Hour
  • Month
 3.9.0
range 报告时间范围 3.9.0
schedulerJobTypes 定时任务类型 3.9.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.9.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.9.0
timeout 是

标签（Tags）

用户可以使用resourceType=ImageVO创建用户标签。 例如：
CreateUserTag resourceType=ImageVO tag=golden-ResourceStack
resourceUuid=8a996d1416ed44ccb183e24f46c34206
上一篇容量管理下一篇CBT任务
CLI命令使用手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心