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

API请求

URLs

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"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"vm1","instanceOfferingUuid":"7d608371542b3ab5960823c1b57bfa0c","l3NetworkUuids":["6ab4d28582d232708ed2912c1c3eb1ef"],"clusterUuid":"84a216b8b0323b87bf9d2b32abc635a3","description":"this is a vm"}}' 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
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
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

Note:

从云主机备份创建云主机时支持指定云盘置备方式，SystemTags增加volumeProvisioningStrategy选项，使用 rootVolumeSystemTags参数来传递 SystemTag。
- 选项格式为：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
- 例如：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning

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": 8.589934592E9,
    "cpuNum": 1.0,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "af856a9c63e53eb5b80999e258221940",
        "vmInstanceUuid": "a1c07d683f693f6e9f2d7f9a499c7840",
        "usedIpUuid": "9856d36e40783d669b9e4f1de41d1a17",
        "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.0,
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "24b9fcb69f123ad6b3ddfffed96d2882",
        "name": "Root-Volume-For-VM-a1c07d683f693f6e9f2d7f9a499c7840",
        "primaryStorageUuid": "be02105c2a223492a91fb09ba664ecb1",
        "vmInstanceUuid": "a1c07d683f693f6e9f2d7f9a499c7840",
        "diskOfferingUuid": "ae47a25fd7cf3a349035d01060a8a224",
        "rootImageUuid": "5c07704333c532e8b402b6b3ddb89315",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-24b9fcb69f123ad6b3ddfffed96d2882/24b9fcb69f123ad6b3ddfffed96d2882.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 1.073741824E11,
        "actualSize": 2.147483648E10,
        "deviceId": 0.0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}


名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.0.0
inventory	VmInstanceInventory	详情参考inventory	3.0.0

#error


名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	3.0.0
description	String	错误的概要描述	3.0.0
details	String	错误的详细信息	3.0.0
elaboration	String	保留字段，默认为null	3.0.0
opaque	LinkedHashMap	保留字段，默认为null	3.0.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	3.0.0

#inventory


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.0.0
name	String	资源名称	3.0.0
description	String	资源的详细描述	3.0.0
zoneUuid	String	区域UUID	3.0.0
clusterUuid	String	集群UUID	3.0.0
imageUuid	String	镜像UUID	3.0.0
hostUuid	String	物理机UUID	3.0.0
lastHostUuid	String		3.0.0
instanceOfferingUuid	String	计算规格UUID	3.0.0
rootVolumeUuid	String	根云盘UUID	3.0.0
platform	String		3.0.0
defaultL3NetworkUuid	String		3.0.0
type	String		3.0.0
hypervisorType	String		3.0.0
memorySize	Long		3.0.0
cpuNum	Integer		3.0.0
cpuSpeed	Long		3.0.0
allocatorStrategy	String		3.0.0
createDate	Timestamp	创建时间	3.0.0
lastOpDate	Timestamp	最后一次修改时间	3.0.0
state	String		3.0.0
vmNics	List	详情参考vmNics	3.0.0
allVolumes	List	详情参考allVolumes	3.0.0

#vmNics


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.0.0
vmInstanceUuid	String	云主机UUID	3.0.0
l3NetworkUuid	String	三层网络UUID	3.0.0
ip	String		3.0.0
mac	String		3.0.0
netmask	String		3.0.0
gateway	String		3.0.0
metaData	String		3.0.0
deviceId	Integer		3.0.0
createDate	Timestamp	创建时间	3.0.0
lastOpDate	Timestamp	最后一次修改时间	3.0.0

#allVolumes


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.0.0
name	String	资源名称	3.0.0
description	String	资源的详细描述	3.0.0
primaryStorageUuid	String	主存储UUID	3.0.0
vmInstanceUuid	String	云主机UUID	3.0.0
diskOfferingUuid	String	云盘规格UUID	3.0.0
rootImageUuid	String		3.0.0
installPath	String		3.0.0
type	String		3.0.0
format	String		3.0.0
size	Long		3.0.0
actualSize	Long		3.0.0
deviceId	Integer		3.0.0
state	String		3.0.0
status	String		3.0.0
createDate	Timestamp	创建时间	3.0.0
lastOpDate	Timestamp	最后一次修改时间	3.0.0
isShareable	Boolean		3.0.0

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.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateVmFromVmBackupAction.Result res = action.call();

Python SDK

CreateVmFromVmBackupAction action = CreateVmFromVmBackupAction()
action.name = "vm1"
action.groupUuid = "04ac2beae2b03def881dea125299498c"
action.instanceOfferingUuid = "7d608371542b3ab5960823c1b57bfa0c"
action.l3NetworkUuids = [6ab4d28582d232708ed2912c1c3eb1ef]
action.clusterUuid = "84a216b8b0323b87bf9d2b32abc635a3"
action.description = "this is a vm"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateVmFromVmBackupAction.Result res = action.call()