克隆虚拟机

PUT/zstack/v1/vm-instances/{vmInstanceUuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/vm-instances/{vmInstanceUuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/vm-instances/{vmInstanceUuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "cloneVmInstance": {
    "strategy": "InstantStart",
    "names": [
      "vm1",
      "vm2"
    ],
    "full": false
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"cloneVmInstance":{"strategy":"InstantStart","names":["vm1","vm2"],"full":false}}' \
http://localhost:8080/zstack/v1/vm-instances/c4d628c203433f64b062ad07c8edf10d/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
vmInstanceUuid	String	url	虚拟机UUID		0.6
strategy (可选)	String	body(包含在cloneVmInstance结构中)	策略	CreateStopped InstantStart JustCreate Note: JustCreate将仅创建虚拟机记录，不会进行任何初始化，且该虚拟机不会在UI展示。	0.6
names	List	body(包含在cloneVmInstance结构中)	虚拟机的名字清单		0.6
full (可选)	Boolean	body(包含在cloneVmInstance结构中	是否克隆已挂载数据盘		2.5.0
systemTags (可选)	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6
primaryStorageUuidForRootVolume (可选)	String	body(包含在cloneVmInstance结构中)			4.6.21
primaryStorageUuidForDataVolume (可选)	String	body(包含在cloneVmInstance结构中)			4.6.21
rootVolumeSystemTags (可选)	List	body(包含在cloneVmInstance结构中)			4.6.21
dataVolumeSystemTags (可选)	List	body(包含在cloneVmInstance结构中)			4.6.21
clusterUuid (可选)	String	body(包含在cloneVmInstance结构中)	集群UUID		4.6.21
hostUuid (可选)	String	body(包含在cloneVmInstance结构中)	主机UUID		4.6.21
diskAOs (可选)	List	body(包含在`cloneVmInstance`结构中)	硬盘参数		4.10.10
description (可选)	String	body(包含在`cloneVmInstance`结构中)	资源的详细描述		4.10.10
vmNicParams (可选)	String	body(包含在`cloneVmInstance`结构中)	网卡参数		4.10.16
vmCustomSpecification (可选)	VmCustomSpecificationStruct	body(包含在`cloneVmInstance`结构中)	虚拟机自定义操作系统		4.10.18
resetTpm (可选)	Boolean	body(包含在`cloneVmInstance`结构中)	创建的虚拟机是否重置 TPM 状态		5.0.0

ZSvirt克隆虚拟机时支持支持亲和组功能，SystemTags增加affinityGroup选项。
- 选项格式为：affinityGroupUuid::UUID
- 例如：affinityGroupUuid::5fd71606d5af451d981413f35367a8d6
ZSvirt克隆虚拟机时支持指定硬盘置备方式，SystemTags增加volumeProvisioningStrategy选项，使用 rootVolumeSystemTags参数来传递 SystemTag。
- 选项格式为：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
- 例如：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning

API返回

该API调用成功后，返回success为true。成功克隆的虚拟机数量由numberOfClonedVm返回。实际过程中，由于资源限制，可能存在部分成功、部分失败的情况。每台虚拟机的克隆失败原因存放在inventories里面的error字段。

返回示例

usterUuid": "f6f07dff7ede3b8cac7c8595a1698832",
          "imageUuid": "3b7ff22eb60d38318835817ba6a2b6a2",
          "hostUuid": "70c0f5223d083dfea2f1a02f69906306",
          "lastHostUuid": "123f7f85f82f3e99940836d97ae18e04",
          "instanceOfferingUuid": "001537d10c433857a7a98ae0a362c910",
          "rootVolumeUuid": "c8be7ec6a8573d98a580b457a7245141",
          "platform": "Linux",
          "defaultL3NetworkUuid": "2ac50b85591b3e87b2686c529cf062f9",
          "type": "UserVm",
          "hypervisorType": "KVM",
          "memorySize": 8589934592,
          "cpuNum": 1,
          "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
          "createDate": "Nov 14, 2017 2:20:57 PM",
          "lastOpDate": "Nov 14, 2017 2:20:57 PM",
          "state": "Running",
          "allVolumes": [
            {
              "uuid": "c8be7ec6a8573d98a580b457a7245141",
              "name": "Root-Volume-For-VM-327b60d6b8cd31489ade6f4830bcec16",
              "primaryStorageUuid": "c2a27c5268493a5cba84b94e37b86b4d",
              "vmInstanceUuid": "327b60d6b8cd31489ade6f4830bcec16",
              "diskOfferingUuid": "358e00e7245a39b9aa1c1849d6ba9701",
              "rootImageUuid": "3b7ff22eb60d38318835817ba6a2b6a2",
              "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-c8be7ec6a8573d98a580b457a7245141/c8be7ec6a8573d98a580b457a7245141.qcow2",
              "type": "Root",
              "format": "qcow2",
              "size": 107374182400,
              "actualSize": 21474836480,
              "deviceId": 0,
              "state": "Enabled",
              "status": "Ready",
              "createDate": "Nov 14, 2017 2:20:57 PM",
              "lastOpDate": "Nov 14, 2017 2:20:57 PM"
            }
          ]
        }
      }
    ]
  }
}

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

error

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

result

名字	类型	描述	起始版本
numberOfClonedVm	int		0.6
inventories	List	详情参考inventories	0.6

inventories

名字	类型	描述	起始版本
error	ErrorCode	详情参考error	0.6
inventory	VmInstanceInventory	详情参考inventory	0.6

error

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

inventory

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

vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
vmInstanceUuid	String	虚拟机UUID	0.6
l3NetworkUuid	String	分布式端口组UUID	0.6
ip	String		0.6
mac	String		0.6
hypervisorType	String		4.6.21
netmask	String		0.6
gateway	String		0.6
metaData	String		0.6
ipVersion	Integer		4.6.21
driverType	String		4.6.21
internalName	String		4.6.21
deviceId	Integer		0.6
type	String		4.6.21
state	String	网卡状态	4.6.21
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
usedIps	List	详情参考usedIps	4.6.21

usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.10.0
ipRangeUuid	String	IP段UUID	4.10.0
l3NetworkUuid	String	分布式端口组UUID	4.10.0
ipVersion	Integer	IP协议号	4.10.0
ip	String	IP地址	4.10.0
netmask	String	子网掩码	4.10.0
gateway	String	网关地址	4.10.0
usedFor	String	分配原因	4.10.0
ipInLong	long	Long存储的IP地址，仅ipv4有效	4.10.0
ipInBinary	byte[]	二进制存储的IP地址（字节数组，IPv4长度4，IPv6长度16，网络序）	4.10.16
vmNicUuid	String	虚拟机网卡UUID	4.10.0
createDate	Timestamp	创建时间	4.10.0
lastOpDate	Timestamp	最后一次修改时间	4.10.0

allVolumes

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

vmCdRoms

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.6.21
vmInstanceUuid	String	虚拟机UUID	4.6.21
deviceId	Integer		4.6.21
isoUuid	String		4.6.21
isoInstallPath	String		4.6.21
name	String	资源名称	4.6.21
description	String	资源的详细描述	4.6.21
createDate	Timestamp	创建时间	4.6.21
lastOpDate	Timestamp	最后一次修改时间	4.6.21

SDK示例

Java SDK

CloneVmInstanceAction action = new CloneVmInstanceAction();
action.vmInstanceUuid = "c4d628c203433f64b062ad07c8edf10d";
action.strategy = "InstantStart";
action.names = asList("vm1","vm2");
action.full = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CloneVmInstanceAction.Result res = action.call();

Python SDK

action = CloneVmInstanceAction()
action.vmInstanceUuid = "c4d628c203433f64b062ad07c8edf10d"
action.strategy = "InstantStart"
action.names = [vm1, vm2]
action.full = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()