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

创建虚拟机(CreateVmInstance)

创建一个新的虚拟机

API请求

URLs
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",
        "volumeBackupTemplate": false
      },
      {
        "boot": false,
        "primaryStorageUuid": "ff0359abb8443d2f8077cc368afa7c00",
        "size": 0,
        "name": "data-volume",
        "volumeBackupTemplate": false
      }
    ],
    "devices": {
      "tpm": {
        "enable": true,
        "keyProviderUuid": "ff03c7091617357eb4022d11c6860e00",
        "resourceKeyCreatedNew": false
      }
    }
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中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","volumeBackupTemplate":false},{"boot":false,"primaryStorageUuid":"ff0359abb8443d2f8077cc368afa7c00","size":0,"name":"data-volume","volumeBackupTemplate":false}],"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结构中) 网卡信息 3.17.0
type (可选) String body(包含在params结构中) 虚拟机类型。保留字段，无需指定。
  • UserVm
  • ApplianceVm
 0.6
rootDiskOfferingUuid (可选) String body(包含在params结构中) 根硬盘规格UUID。如果imageUuid字段指定的镜像类型是ISO，该字段必须指定以确定需要创建的根硬盘大小。如果镜像类型是非ISO，该字段无需指定。 0.6
dataDiskSizes (可选) List body(包含在params结构中) 自定义硬盘大小列表。可以指定一个或多个硬盘大小（可重复）为虚拟机创建一个或多个数据硬盘。 3.14.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
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结构中) 3.14.24
sshKeyPairUuids (可选) List body(包含在params结构中) 3.17.21
dataVolumeTemplateUuids (可选) List body(包含在params结构中) 3.17.0
diskAOs (可选) List body(包含在params结构中) boot=true表示diskAO用于设置虚拟机平台、架构、操作系统与根盘总线；diskAO.boot=false表示加载的硬盘 3.17.0
platform (可选) String body(包含在params结构中) 3.17.0
guestOsType (可选) String body(包含在params结构中) 3.17.0
architecture (可选) String body(包含在params结构中) 3.17.21
reservedMemorySize (可选) Long body(包含在params结构中) 3.17.21
virtio (可选) Boolean body(包含在params结构中) 3.17.0
allocatorStrategy (可选) String body(包含在params结构中) 虚拟机分配策略 4.10.10
vmEncryption (可选) Boolean body(包含在params结构中) 虚拟机是否加密 5.1.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"
      }
    ]
  }
}
名字 类型 描述 起始版本
success boolean 0.6
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考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 上一次启动的主机 UUID 0.6
instanceOfferingUuid String 计算规格 UUID, 已废弃 0.6
rootVolumeUuid String 根硬盘 UUID 0.6
platform String 虚拟机的平台, 是 Windows / Linux 还是其它 0.6
architecture String 虚拟机架构, 是 x86_64 / aarch64 还是其它 0.6
defaultL3NetworkUuid String 默认使用的分布式端口组 UUID 0.6
type String 虚拟机类型, 是用户使用虚拟机还是平台特殊用途的虚拟机 0.6
hypervisorType String 虚拟机虚拟化类型, 一般为 KVM 0.6
memorySize Long 内存大小 0.6
cpuNum Integer CPU 数量 0.6
cpuSpeed Long CPU 速度 0.6
allocatorStrategy String 虚拟机分配策略 0.6
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
state String 虚拟机是否启用的状态 0.6
guestOsType String 虚拟机宿主操作系统类型 3.11.2
vmNics List 详情参考vmNics 0.6
allVolumes List 详情参考allVolumes 0.6
vmCdRoms List 详情参考vmCdRoms 0.6
#vmNics
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.17.13
vmInstanceUuid String 虚拟机UUID 3.17.13
l3NetworkUuid String 分布式端口组UUID 3.17.13
ip String 3.17.13
mac String 3.17.13
hypervisorType String 3.17.13
netmask String 3.17.13
gateway String 3.17.13
metaData String 3.17.13
ipVersion Integer 3.17.13
driverType String 3.17.13
internalName String 3.17.13
deviceId Integer 3.17.13
type String 3.17.13
state String 网卡状态 3.17.13
createDate Timestamp 创建时间 3.17.13
lastOpDate Timestamp 最后一次修改时间 3.17.13
usedIps List 详情参考usedIps 3.17.13
#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
vmNicUuid String 虚拟机网卡UUID 4.10.0
createDate Timestamp 创建时间 4.10.0
lastOpDate Timestamp 最后一次修改时间 4.10.0
#allVolumes
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.17.13
name String 资源名称 3.17.13
description String 资源的详细描述 3.17.13
primaryStorageUuid String 数据存储UUID 3.17.13
vmInstanceUuid String 虚拟机UUID 3.17.13
diskOfferingUuid String 硬盘规格UUID 3.17.13
rootImageUuid String 3.17.13
installPath String 3.17.13
type String 3.17.13
format String 3.17.13
size Long 3.17.13
actualSize Long 3.17.13
deviceId Integer 3.17.13
state String 3.17.13
status String 3.17.13
createDate Timestamp 创建时间 3.17.13
lastOpDate Timestamp 最后一次修改时间 3.17.13
isShareable Boolean 3.17.13
volumeQos String 3.17.13
lastDetachDate Timestamp 3.17.13
lastVmInstanceUuid String 3.17.13
encrypted Boolean 5.1.0
#vmCdRoms
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.17.13
vmInstanceUuid String 虚拟机UUID 3.17.13
deviceId Integer 3.17.13
isoUuid String 3.17.13
isoInstallPath String 3.17.13
name String 资源名称 3.17.13
description String 资源的详细描述 3.17.13
createDate Timestamp 创建时间 3.17.13
lastOpDate Timestamp 最后一次修改时间 3.17.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()
上一篇虚拟机相关接口下一篇从硬盘新建虚拟机(CreateVmInstanceFromVolume)
开发手册 | ZStack ZSphere · ZVF | ZStack 资源中心