文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›开发手册ZCF
文档目录

克隆云主机(CloneVmInstance)

API请求

URLs
PUT zstack/v1/vm-instances/{vmInstanceUuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "cloneVmInstance": {
    "strategy": "InstantStart",
    "names": [
      "vm1",
      "vm2"
    ],
    "full": false
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中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
vmNicParams (可选) List body(包含在cloneVmInstance结构中) 网卡参数 5.1.0

API返回

返回示例
{
  "result": {
    "numberOfClonedVm": 1,
    "inventories": [
      {
        "inventory": {
          "uuid": "327b60d6b8cd31489ade6f4830bcec16",
          "name": "new vm name",
          "description": "web server VM",
          "zoneUuid": "d886a09330e13282b7a320a98d0a53ec",
          "clusterUuid": "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 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10: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 10:20:57 PM",
              "lastOpDate": "Nov 14, 2017 10: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，唯一标示该资源 4.7.13
vmInstanceUuid String 云主机UUID 4.7.13
l3NetworkUuid String 三层网络UUID 4.7.13
ip String 4.7.13
mac String 4.7.13
hypervisorType String 4.7.13
netmask String 4.7.13
gateway String 4.7.13
metaData String 4.7.13
ipVersion Integer 4.7.13
driverType String 4.7.13
internalName String 4.7.13
deviceId Integer 4.7.13
type String 4.7.13
state String 网卡状态 4.7.13
createDate Timestamp 创建时间 4.7.13
lastOpDate Timestamp 最后一次修改时间 4.7.13
usedIps List 详情参考usedIps 4.7.13
#usedIps
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.0.0
ipRangeUuid String IP段UUID 5.0.0
l3NetworkUuid String 三层网络UUID 5.0.0
ipVersion Integer 5.0.0
ip String 5.0.0
netmask String 5.0.0
gateway String 5.0.0
usedFor String 5.0.0
ipInLong long 5.0.0
vmNicUuid String 云主机网卡UUID 5.0.0
createDate Timestamp 创建时间 5.0.0
lastOpDate Timestamp 最后一次修改时间 5.0.0
#allVolumes
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.7.13
name String 资源名称 4.7.13
description String 资源的详细描述 4.7.13
primaryStorageUuid String 主存储UUID 4.7.13
vmInstanceUuid String 云主机UUID 4.7.13
diskOfferingUuid String 云盘规格UUID 4.7.13
rootImageUuid String 4.7.13
installPath String 4.7.13
type String 4.7.13
format String 4.7.13
size Long 4.7.13
actualSize Long 4.7.13
deviceId Integer 4.7.13
state String 4.7.13
status String 4.7.13
createDate Timestamp 创建时间 4.7.13
lastOpDate Timestamp 最后一次修改时间 4.7.13
isShareable Boolean 4.7.13
volumeQos String 4.7.13
lastDetachDate Timestamp 4.7.13
lastVmInstanceUuid String 4.7.13
#vmCdRoms
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 4.7.13
vmInstanceUuid String 云主机UUID 4.7.13
deviceId Integer 4.7.13
isoUuid String 4.7.13
isoInstallPath String 4.7.13
name String 资源名称 4.7.13
description String 资源的详细描述 4.7.13
createDate Timestamp 创建时间 4.7.13
lastOpDate Timestamp 最后一次修改时间 4.7.13

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
CloneVmInstanceAction action = CloneVmInstanceAction()
action.vmInstanceUuid = "c4d628c203433f64b062ad07c8edf10d"
action.strategy = "InstantStart"
action.names = [vm1, vm2]
action.full = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CloneVmInstanceAction.Result res = action.call()
上一篇更新云主机信息(UpdateVmInstance)下一篇设置云主机时钟同步（SetVmClockTrack）
开发手册 | 5.5.30 | ZStack Cloud · ZCF | ZStack 资源中心