虚拟机相关接口

新建虚拟机

POST/zstack/v1/vm-instances

创建一个新的虚拟机。

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "vm1",
    "l3NetworkUuids": [
      "19d22d051b063d379a2816daaf431838"
    ],
    "clusterUuid": "a0468dc645223f67bd0f2ab95276bbae",
    "description": "this is a vm",
    "strategy": "InstantStart",
    "diskAOs": [
      {
        "boot": true,
        "platform": "Linux",
        "guestOsType": "Helix 8",
        "architecture": "x86_64",
        "primaryStorageUuid": "ff0359abb8443d2f8077cc368afa7c00",
        "size": 0,
        "sourceType": "VolumeVO",
        "sourceUuid": "ff0eb5a723e9316bb1053ed7e4bb3100",
        "systemTags": [
          "volumeProvisioningStrategy::ThickProvisioning"
        ],
        "name": "root-volume"
      },
      {
        "boot": false,
        "primaryStorageUuid": "ff0359abb8443d2f8077cc368afa7c00",
        "size": 0,
        "name": "data-volume"
      }
    ],
    "devices": {
      "tpm": {
        "enable": true,
        "keyProviderUuid": "ff03c7091617357eb4022d11c6860e00",
        "resourceKeyCreatedNew": false
      }
    }
  },
  "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","l3NetworkUuids":["19d22d051b063d379a2816daaf431838"],"clusterUuid":"a0468dc645223f67bd0f2ab95276bbae","description":"this is a vm","strategy":"InstantStart","diskAOs":[{"boot":true,"platform":"Linux","guestOsType":"Helix 8","architecture":"x86_64","primaryStorageUuid":"ff0359abb8443d2f8077cc368afa7c00","size":0,"sourceType":"VolumeVO","sourceUuid":"ff0eb5a723e9316bb1053ed7e4bb3100","systemTags":["volumeProvisioningStrategy::ThickProvisioning"],"name":"root-volume"},{"boot":false,"primaryStorageUuid":"ff0359abb8443d2f8077cc368afa7c00","size":0,"name":"data-volume"}],"devices":{"tpm":{"enable":true,"keyProviderUuid":"ff03c7091617357eb4022d11c6860e00","resourceKeyCreatedNew":false}}}}'
http://localhost:8080/zstack/v1/vm-instances

参数列表

名字

类型

位置

描述

可选值

起始版本

name

String

body(包含在params结构中)

虚拟机名称

 

0.6

instanceOfferingUuid (可选)

String

body(包含在params结构中)

计算规格UUID- 指定虚拟机的CPU、内存等参数。

 

0.6

imageUuid (可选)

String

body(包含在params结构中)

镜像UUID- 虚拟机的根硬盘会从该字段指定的镜像创建。

 

0.6

l3NetworkUuids (可选)

List

body(包含在params结构中)

分布式端口组UUID列表- 可指定一个或多个分布式端口组，虚拟机会在每个分布式端口组上创建一个网卡。

 

0.6

vmNicParams (可选)

String

body(包含在params结构中)

网卡信息

 

4.7.0

type (可选)

String

body(包含在params结构中)

虚拟机类型- 保留字段，无需指定。

  • UserVm
  • ApplianceVm

0.6

rootDiskOfferingUuid (可选)

String

body(包含在params结构中)

根硬盘规格UUID- 如果imageUuid字段指定的镜像类型是ISO，该字段必须指定以确定需要创建的根硬盘大小。

  • 如果镜像类型是非ISO，该字段无需指定。

 

0.6

dataDiskSizes (可选)

List

body(包含在params结构中)

自定义硬盘大小列表。可以指定一个或多个硬盘大小（可重复）为虚拟机创建一个或多个数据硬盘。

 

4.4.6

dataDiskOfferingUuids (可选)

List

body(包含在params结构中)

硬盘规格UUID列表- 可指定一个或多个硬盘规格UUID（UUID可以重复）为虚拟机创建一个或多个数据硬盘。

 

0.6

zoneUuid (可选)

String

body(包含在params结构中)

数据中心UUID- 若指定，虚拟机会在指定数据中心创建。

 

0.6

clusterUuid (可选)

String

body(包含在params结构中)

集群UUID- 若指定，虚拟机会在指定集群创建，该字段优先级高于zoneUuid。

 

0.6

hostUuid (可选)

String

body(包含在params结构中)

主机UUID- 若指定，虚拟机会在指定主机创建，该字段优先级高于zoneUuid和clusterUuid。

 

0.6

primaryStorageUuidForRootVolume (可选)

String

body(包含在params结构中)

数据存储UUID- 若指定，虚拟机的根硬盘会在指定数据存储创建。

 

1.8

description (可选)

String

body(包含在params结构中)

虚拟机的详细描述

 

0.6

defaultL3NetworkUuid (可选)

String

body(包含在params结构中)

默认分布式端口组UUID- 当l3NetworkUuids指定了多个分布式端口组时，该字段指定提供默认路由的分布式端口组。

  • 若不指定，l3NetworkUuids的第一个网络被选为默认网络。

 

0.6

resourceUuid (可选)

String

body(包含在params结构中)

资源UUID- 若指定，虚拟机会使用该字段值作为UUID。

 

0.6

tagUuids (可选)

List

body(包含在params结构中)

标签UUID列表

 

3.4.0

systemTags (可选)

List

body

虚拟机系统标签

 

0.6

userTags (可选)

List

body

虚拟机用户标签

 

0.6

strategy (可选)

String

body(包含在params结构中)

虚拟机创建策略- 创建后立刻启动

  • 创建后不启动
  • InstantStart
  • JustCreate
  • CreateStopped

0.6

rootVolumeSystemTags (可选)

List

body(包含在params结构中)

虚拟机根盘所需要的系统标签

 

3.0

dataVolumeSystemTags (可选)

List

body(包含在params结构中)

虚拟机数据盘所需要的系统标签

 

3.0

cpuNum (可选)

Integer

body(包含在params结构中)

 

 

3.4.0

memorySize (可选)

Long

body(包含在params结构中)

 

 

3.4.0

rootDiskSize (可选)

Long

body(包含在params结构中)

 

 

3.4.0

dataVolumeSystemTagsOnIndex (可选)

Map

body(包含在params结构中)

 

 

4.4.24

sshKeyPairUuids (可选)

List

body(包含在params结构中)

 

 

4.7.21

dataVolumeTemplateUuids (可选)

List

body(包含在params结构中)

 

 

4.7.0

diskAOs (可选)

List

body(包含在params结构中)

boot=true表示diskAO用于设置虚拟机平台、架构、操作系统与根盘总线；diskAO.boot=false表示加载的硬盘

 

4.7.0

platform

String

body(包含在params结构中)

 

 

4.7.0

guestOsType

String

body(包含在params结构中)

 

 

4.7.0

architecture

String

body(包含在params结构中)

 

 

4.7.21

reservedMemorySize (可选)

Long

body(包含在params结构中)

 

 

4.7.21

virtio (可选)

Boolean

body(包含在params结构中)

 

 

4.7.0

API返回

返回示例

{
  "inventory": {
    "uuid": "6efab7159c6932429c6b0e7e0b64b660",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "d10bd7a9565138efaf6171db8e18fa7d",
    "clusterUuid": "692c71639d873bf6a356cd8e285d0d9c",
    "imageUuid": "28061e65e48037eda71b53a0732bf087",
    "hostUuid": "f877177de7bd377e811bc6313878b2b1",
    "lastHostUuid": "a3ccdc90a600334f994c69aee4270ac5",
    "instanceOfferingUuid": "9a874241f867333ca0bf0ab2134f8515",
    "rootVolumeUuid": "f52d7c94d69d3bbb97d36a270fe910c3",
    "platform": "Linux",
    "defaultL3NetworkUuid": "2ac1b70fdb0f38769a29c6ebd0262cca",
    "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",
    "vmNics": [
      {
        "uuid": "0dfbb8a297e9349ea8799c4ce48c6d10",
        "vmInstanceUuid": "6efab7159c6932429c6b0e7e0b64b660",
        "usedIpUuid": "39b57596a8ba35289bd9f40efceeae03",
        "l3NetworkUuid": "2ac1b70fdb0f38769a29c6ebd0262cca",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "hypervisorType": "KVM",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "f52d7c94d69d3bbb97d36a270fe910c3",
        "name": "Root-Volume-For-VM-6efab7159c6932429c6b0e7e0b64b660",
        "primaryStorageUuid": "4ed5bbb150a034b5917e7e6c9c4b8170",
        "vmInstanceUuid": "6efab7159c6932429c6b0e7e0b64b660",
        "diskOfferingUuid": "0521187274d73f5b936c22b145384c74",
        "rootImageUuid": "28061e65e48037eda71b53a0732bf087",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-f52d7c94d69d3bbb97d36a270fe910c3/f52d7c94d69d3bbb97d36a270fe910c3.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"
      }
    ]
  }
}
名字类型描述起始版本
successboolean 0.6
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error0.6
inventoryVmInstanceInventory详情参考inventory0.6

error

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

inventory

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源0.6
nameString资源名称0.6
descriptionString资源的详细描述0.6
zoneUuidString数据中心UUID0.6
clusterUuidString集群UUID0.6
imageUuidString镜像UUID0.6
hostUuidString主机UUID0.6
lastHostUuidString上一次运行虚拟机的主机UUID0.6
instanceOfferingUuidString计算规格UUID0.6
rootVolumeUuidString根硬盘UUID0.6
platformString虚拟机运行平台0.6
architectureString 0.6
defaultL3NetworkUuidString默认分布式端口组UUID0.6
typeString虚拟机类型0.6
hypervisorTypeString虚拟机的hypervisor类型0.6
memorySizeLong内存大小0.6
cpuNumIntegercpu数量0.6
cpuSpeedLongcpu主频0.6
allocatorStrategyString分配策略0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
stateString虚拟机的可用状态0.6
guestOsTypeString 4.1.2
vmNicsList详情参考vmNics0.6
allVolumesList详情参考allVolumes0.6
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 4.7.13
stateString网卡状态4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13
usedIpsList详情参考usedIps4.7.13

usedIps

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

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
nameString资源名称4.7.13
descriptionString资源的详细描述4.7.13
primaryStorageUuidString数据存储UUID4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
diskOfferingUuidString硬盘规格UUID4.7.13
rootImageUuidString 4.7.13
installPathString 4.7.13
typeString 4.7.13
formatString 4.7.13
sizeLong 4.7.13
actualSizeLong 4.7.13
deviceIdInteger 4.7.13
stateString 4.7.13
statusString 4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13
isShareableBoolean 4.7.13
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

CreateVmInstanceAction action = new CreateVmInstanceAction();
action.name = "vm1";
action.l3NetworkUuids = asList("19d22d051b063d379a2816daaf431838");
action.clusterUuid = "a0468dc645223f67bd0f2ab95276bbae";
action.description = "this is a vm";
action.strategy = "InstantStart";
action.diskAOs = asList([boot:true, platform:Linux, guestOsType:Helix 8, architecture:x86_64, primaryStorageUuid:ff0359abb8443d2f8077cc368afa7c00, size:0, sourceType:VolumeVO, sourceUuid:ff0eb5a723e9316bb1053ed7e4bb3100, systemTags:[volumeProvisioningStrategy::ThickProvisioning], name:root-volume],[boot:false, primaryStorageUuid:ff0359abb8443d2f8077cc368afa7c00, size:0, name:data-volume]);
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateVmInstanceAction.Result res = action.call();

Python SDK

action = CreateVmInstanceAction()
action.name = "vm1"
action.l3NetworkUuids = [19d22d051b063d379a2816daaf431838]
action.clusterUuid = "a0468dc645223f67bd0f2ab95276bbae"
action.description = "this is a vm"
action.strategy = "InstantStart"
action.diskAOs = [[boot:true, platform:Linux, guestOsType:Helix 8, architecture:x86_64, primaryStorageUuid:ff0359abb8443d2f8077cc368afa7c00, size:0, sourceType:VolumeVO, sourceUuid:ff0eb5a723e9316bb1053ed7e4bb3100, systemTags:[volumeProvisioningStrategy::ThickProvisioning], name:root-volume], [boot:false, primaryStorageUuid:ff0359abb8443d2f8077cc368afa7c00, size:0, name:data-volume]]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

返回 API 文档

上一页

POST从硬盘新建虚拟机

下一页