备份管理相关接口

从虚拟机备份创建虚拟机

POST/zstack/v1/vm-instances/from/vm-backups/{groupUuid}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "vm1",
    "instanceOfferingUuid": "7d608371542b3ab5960823c1b57bfa0c",
    "l3NetworkUuids": [
      "6ab4d28582d232708ed2912c1c3eb1ef"
    ],
    "clusterUuid": "84a216b8b0323b87bf9d2b32abc635a3",
    "description": "this is a vm",
    "diskAOs": [
      {
        "boot": false,
        "primaryStorageUuid": "2b7a5bd210ed3b1ea9d746f714a79eaf",
        "size": 0,
        "sourceUuid": "b205ac85f069349eafe837afadd173df"
      }
    ],
    "strategy": "InstantStart"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"vm1","instanceOfferingUuid":"7d608371542b3ab5960823c1b57bfa0c","l3NetworkUuids":["6ab4d28582d232708ed2912c1c3eb1ef"],"clusterUuid":"84a216b8b0323b87bf9d2b32abc635a3","description":"this is a vm","strategy":"InstantStart"}}' \
http://localhost:8080/zstack/v1/vm-instances/from/vm-backups/04ac2beae2b03def881dea125299498c

参数列表

名字

类型

位置

描述

可选值

起始版本

name

String

body(包含在params结构中)

资源名称

 

3.0.0

groupUuid

String

url

虚拟机备份组UUID

 

3.0.0

backupStorageUuid (可选)

String

body(包含在params结构中)

镜像存储UUID

 

0.6

instanceOfferingUuid (可选)

String

body(包含在params结构中)

计算规格UUID

 

3.0.0

l3NetworkUuids（可选）

List

body(包含在params结构中)

一组分布式端口组的UUID

 

3.0.0

vmNicParams (可选)

String

body(包含在params结构中)

网卡信息

 

4.7.0

type (可选)

String

body(包含在params结构中)

虚拟机类型

  • UserVm
  • ApplianceVm

3.0.0

zoneUuid (可选)

String

body(包含在params结构中)

数据中心UUID

 

3.0.0

clusterUuid (可选)

String

body(包含在params结构中)

集群UUID

 

3.0.0

hostUuid (可选)

String

body(包含在params结构中)

主机UUID

 

3.0.0

primaryStorageUuidForRootVolume (可选)

String

body(包含在params结构中)

根硬盘数据存储UUID

 

3.0.0

primaryStorageUuidForDataVolume (可选)

String

body(包含在params结构中)

数据盘数据存储UUID

 

3.0.0

description (可选)

String

body(包含在params结构中)

资源的详细描述

 

3.0.0

rootVolumeSystemTags (可选)

List

body(包含在params结构中)

根硬盘系统标签

 

3.0.0

dataVolumeSystemTags (可选)

List

body(包含在params结构中)

数据盘系统标签

 

3.0.0

diskAOs (可选)

List

body(包含在params结构中)

按云盘维度传递参数，DiskAO.sourceUuid 与备份对应的原始云盘UUID (VolumeBackupVO.volumeUuid) 绑定；可为每块云盘单独指定 primaryStorageUuid、systemTags 等。注意：diskAOs 与 primaryStorageUuidForRootVolume/primaryStorageUuidForDataVolume、rootVolumeSystemTags/dataVolumeSystemTags 互斥，不能同时指定

 

5.0.0

defaultL3NetworkUuid (可选)

String

body(包含在params结构中)

默认分布式端口组的UUID

 

3.0.0

resourceUuid (可选)

String

body(包含在params结构中)

 

 

3.0.0

systemTags (可选)

List

body

系统标签

 

3.0.0

userTags (可选)

List

body

用户标签

 

3.0.0

tagUuids (可选)

List

body(包含在params结构中)

标签UUID列表

 

3.4.0

strategy (可选)

String

body(包含在params结构中)

虚拟机创建策略

  • InstantStart
  • JustCreate
  • CreateStopped

4.10.0

cpuNum (可选)

Integer

body(包含在params结构中)

 

 

4.3.0

memorySize (可选)

Long

body(包含在params结构中)

 

 

4.3.0

reservedMemorySize (可选)

Long

body(包含在params结构中)

 

 

4.3.0

API返回

返回示例

{
  "inventory": {
    "uuid": "a1c07d683f693f6e9f2d7f9a499c7840",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "1e48b41ec4b63660b38a72d271c0164b",
    "clusterUuid": "f29498f04b1e3c319bdaeb6b3f8259f3",
    "imageUuid": "5c07704333c532e8b402b6b3ddb89315",
    "hostUuid": "e18cf66eedb3306686a1d4685bbb63af",
    "lastHostUuid": "4834161c409a34b6a84e40d71d85f714",
    "instanceOfferingUuid": "f53ad9f147203b499dfbd93ce41b7a8e",
    "rootVolumeUuid": "24b9fcb69f123ad6b3ddfffed96d2882",
    "platform": "Linux",
    "defaultL3NetworkUuid": "d50554f493153be78f6740e18e598046",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 9:20:57 AM",
    "lastOpDate": "Nov 14, 2017 9:20:57 AM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "9856d36e40783d669b9e4f1de41d1a17",
        "vmInstanceUuid": "a1c07d683f693f6e9f2d7f9a499c7840",
        "usedIpUuid": "be02105c2a223492a91fb09ba664ecb1",
        "l3NetworkUuid": "d50554f493153be78f6740e18e598046",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "24b9fcb69f123ad6b3ddfffed96d2882",
        "name": "Root-Volume-For-VM-a1c07d683f693f6e9f2d7f9a499c7840",
        "primaryStorageUuid": "ae47a25fd7cf3a349035d01060a8a224",
        "vmInstanceUuid": "a1c07d683f693f6e9f2d7f9a499c7840",
        "rootImageUuid": "5c07704333c532e8b402b6b3ddb89315",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-24b9fcb69f123ad6b3ddfffed96d2882/24b9fcb69f123ad6b3ddfffed96d2882.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      }
    ]
  }
}
名字类型描述起始版本
successboolean 3.0.0
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error3.0.0
inventoryVmInstanceInventory详情参考inventory3.0.0

error

名字类型描述起始版本
codeString错误码号，错误的全局唯一标识，例如SYS.1000, HOST.10013.0.0
descriptionString错误的概要描述3.0.0
detailsString错误的详细信息3.0.0
elaborationString保留字段，默认为null3.0.0
opaqueLinkedHashMap保留字段，默认为null3.0.0
causeErrorCode根错误，引发当前错误的源错误，若无原错误，该字段为null3.0.0

inventory

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.0.0
nameString资源名称3.0.0
descriptionString资源的详细描述3.0.0
zoneUuidString数据中心UUID3.0.0
clusterUuidString集群UUID3.0.0
imageUuidString镜像UUID3.0.0
hostUuidString主机UUID3.0.0
lastHostUuidString 3.0.0
instanceOfferingUuidString计算规格UUID3.0.0
rootVolumeUuidString根硬盘UUID3.0.0
platformString 3.0.0
architectureString 5.1.0
defaultL3NetworkUuidString 3.0.0
typeString 3.0.0
hypervisorTypeString 3.0.0
memorySizeLong 3.0.0
cpuNumInteger 3.0.0
cpuSpeedLong 3.0.0
allocatorStrategyString 3.0.0
createDateTimestamp创建时间3.0.0
lastOpDateTimestamp最后一次修改时间3.0.0
stateString 3.0.0
guestOsTypeString 4.1.2
vmNicsList详情参考vmNics3.0.0
allVolumesList详情参考allVolumes3.0.0
vmCdRomsList详情参考vmCdRoms0.6

vmNics

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
l3NetworkUuidString分布式端口组UUID4.7.13
ipString 4.7.13
macString 4.7.13
hypervisorTypeString 4.7.13
netmaskString 4.7.13
gatewayString 4.7.13
metaDataString 4.7.13
ipVersionInteger 4.7.13
driverTypeString 4.7.13
internalNameString 4.7.13
deviceIdInteger 4.7.13
typeString  
stateString网卡状态4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13
usedIpsList详情参考usedIps4.7.13

usedIps

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源5.0.0
ipRangeUuidStringIP段UUID5.0.0
l3NetworkUuidString分布式端口组UUID5.0.0
ipVersionInteger 5.0.0
ipString 5.0.0
netmaskString 5.0.0
gatewayString 5.0.0
usedForString 5.0.0
ipInLonglong 5.0.0
vmNicUuidString虚拟机网卡UUID5.0.0
createDateTimestamp创建时间5.0.0
lastOpDateTimestamp最后一次修改时间5.0.0

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.0.0
nameString资源名称3.0.0
descriptionString资源的详细描述3.0.0
primaryStorageUuidString数据存储UUID3.0.0
vmInstanceUuidString虚拟机UUID3.0.0
diskOfferingUuidString硬盘规格UUID3.0.0
rootImageUuidString 3.0.0
installPathString 3.0.0
typeString 3.0.0
formatString 3.0.0
sizeLong 3.0.0
actualSizeLong 3.0.0
deviceIdInteger 3.0.0
stateString 3.0.0
statusString 3.0.0
createDateTimestamp创建时间3.0.0
lastOpDateTimestamp最后一次修改时间3.0.0
isShareableBoolean 3.0.0
volumeQosString 4.7.13
lastDetachDateTimestamp 4.7.13
lastVmInstanceUuidString 4.7.13

vmCdRoms

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
deviceIdInteger 4.7.13
isoUuidString 4.7.13
isoInstallPathString 4.7.13
nameString资源名称4.7.13
descriptionString资源的详细描述4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13

SDK示例

Java SDK

CreateVmFromVmBackupAction action = new CreateVmFromVmBackupAction();
action.name = "vm1";
action.groupUuid = "04ac2beae2b03def881dea125299498c";
action.instanceOfferingUuid = "7d608371542b3ab5960823c1b57bfa0c";
action.l3NetworkUuids = asList("6ab4d28582d232708ed2912c1c3eb1ef");
action.clusterUuid = "84a216b8b0323b87bf9d2b32abc635a3";
action.description = "this is a vm";
action.diskAOs = asList([boot:false, primaryStorageUuid:2b7a5bd210ed3b1ea9d746f714a79eaf, size:0, sourceUuid:b205ac85f069349eafe837afadd173df]);
action.strategy = "InstantStart";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateVmFromVmBackupAction.Result res = action.call();

Python SDK

action = CreateVmFromVmBackupAction()
action.name = "vm1"
action.groupUuid = "04ac2beae2b03def881dea125299498c"
action.instanceOfferingUuid = "7d608371542b3ab5960823c1b57bfa0c"
action.l3NetworkUuids = [6ab4d28582d232708ed2912c1c3eb1ef]
action.clusterUuid = "84a216b8b0323b87bf9d2b32abc635a3"
action.description = "this is a vm"
action.diskAOs = [[boot:false, primaryStorageUuid:2b7a5bd210ed3b1ea9d746f714a79eaf, size:0, sourceUuid:b205ac85f069349eafe837afadd173df]]
action.strategy = "InstantStart"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PUT扫描虚拟机备份

上一页

POST从备份创建虚拟机

下一页