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

从云盘创建云主机(CreateVmInstanceFromVolume)

API请求

URLs
POST zstack/v1/vm-instances/from/volume
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "name": "vm1",
    "description": "this is a vm",
    "instanceOfferingUuid": "80c606e35bc038bbb102e31cae191ea2",
    "l3NetworkUuids": [
      "333817afcaf63f13a101f674761c8a77"
    ],
    "volumeUuid": "23984cd68b903fd4883aa962c70d83fc",
    "clusterUuid": "ada53eb6c42e34d3946ff1280718d9f2",
    "strategy": "InstantStart"
  },
  "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","description":"this is a vm","instanceOfferingUuid":"80c606e35bc038bbb102e31cae191ea2","l3NetworkUuids":["333817afcaf63f13a101f674761c8a77"],"volumeUuid":"23984cd68b903fd4883aa962c70d83fc","clusterUuid":"ada53eb6c42e34d3946ff1280718d9f2","strategy":"InstantStart"}}' http://localhost:8080/zstack/v1/vm-instances/from/volume
参数列表
名字 类型 位置 描述 可选值 起始版本
name String body(包含在params结构中) 资源名称 3.10.0
description (可选) String body(包含在params结构中) 资源的详细描述 3.10.0
instanceOfferingUuid (可选) String body(包含在params结构中) 计算规格UUID，注意：该参数与CPU数量、内存大小二选一 3.10.0
cpuNum (可选) Integer body(包含在params结构中) CPU核数，单位为GB，该参数与instanceOfferingUuid二选一 3.10.0
memorySize (可选) Long body(包含在params结构中) 内存大小，单位为Byte，该参数与instanceOfferingUuid二选一 3.10.0
l3NetworkUuids List body(包含在params结构中) 三层网络UUID
  • 可指定一个或多个三层网络，云主机会在每个三层网络上创建一个网卡。
 3.10.0
type (可选) String body(包含在params结构中) 云主机类型
  • 保留字段，无需指定。
  • UserVm
  • ApplianceVm
 3.10.0
volumeUuid String body(包含在params结构中) 云盘UUID 4.1.0
platform (可选) String body(包含在params结构中) 云盘系统平台
  • Linux
  • Windows
  • Other
 3.10.0
zoneUuid (可选) String body(包含在params结构中) 区域UUID
  • 若指定，云主机会在指定区域创建。
 3.10.0
clusterUuid (可选) String body(包含在params结构中) 集群UUID
  • 若指定，云主机会在指定集群创建，该字段优先级高于zoneUuid。
 3.10.0
hostUuid (可选) String body(包含在params结构中) 物理机UUID
  • 若指定，云主机会在指定物理机创建，该字段优先级高于zoneUuid和clusterUuid。
 3.10.0
primaryStorageUuid (可选) String body(包含在params结构中) 主存储UUID
  • 若指定，云主机的根云盘会在指定主存储创建。
 3.10.0
defaultL3NetworkUuid (可选) String body(包含在params结构中) 默认三层网络UUID
  • 当l3NetworkUuids指定了多个三层网络时，该字段指定提供默认路由的三层网络。
  • 若不指定，l3NetworkUuids的第一个网络被选为默认网络。
 3.10.0
strategy (可选) String body(包含在params结构中) 云主机创建策略
  • 创建后立刻启动
  • 创建后不启动
  • InstantStart
  • CreateStopped
 3.10.0
resourceUuid (可选) String body(包含在params结构中) 资源UUID
  • 若指定，云主机会使用该字段值作为UUID。
 3.10.0
tagUuids (可选) List body(包含在params结构中) 标签UUID列表 3.10.0
systemTags (可选) List body 云主机系统标签 3.10.0
userTags (可选) List body 云主机用户标签 3.10.0

API返回

返回示例
{
  "inventory": {
    "uuid": "33614668ae7d386c91d662928f60b23f",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "62f048b02e353ba4bdb9184ad7f54170",
    "clusterUuid": "ff753adc06c83d5ab2b0291f57b4745a",
    "imageUuid": "9291412f184f37a284b484b0788b24ca",
    "hostUuid": "0f9f5c6561d733d18a94577c4cd0976f",
    "lastHostUuid": "dc452dde2f7832b29bf91a0ddb6a004c",
    "instanceOfferingUuid": "b35adab33ba139b98ee20c1e2be702d3",
    "rootVolumeUuid": "f54fc6d488133688a6a7635f5c44a288",
    "platform": "Linux",
    "defaultL3NetworkUuid": "d82e3c622f933054a1939fb66e07681e",
    "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": "16198ebdef9c3f8084acd1a919eff4f2",
        "vmInstanceUuid": "33614668ae7d386c91d662928f60b23f",
        "usedIpUuid": "8eb3618f949a3e588acf9d8b0ee8293f",
        "l3NetworkUuid": "d82e3c622f933054a1939fb66e07681e",
        "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.0,
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "f54fc6d488133688a6a7635f5c44a288",
        "name": "Root-Volume-For-VM-33614668ae7d386c91d662928f60b23f",
        "primaryStorageUuid": "769061e63aec3278b1e6c3619d6da766",
        "vmInstanceUuid": "33614668ae7d386c91d662928f60b23f",
        "rootImageUuid": "9291412f184f37a284b484b0788b24ca",
        "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-f54fc6d488133688a6a7635f5c44a288/f54fc6d488133688a6a7635f5c44a288.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.10.0
inventory VmInstanceInventory 详情参考inventory 3.10.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 3.10.0
description String 错误的概要描述 3.10.0
details String 错误的详细信息 3.10.0
elaboration String 保留字段，默认为null 3.10.0
opaque LinkedHashMap 保留字段，默认为null 3.10.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 3.10.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.10.0
name String 资源名称 3.10.0
description String 资源的详细描述 3.10.0
zoneUuid String 区域UUID 3.10.0
clusterUuid String 集群UUID 3.10.0
imageUuid String 镜像UUID 3.10.0
hostUuid String 物理机UUID 3.10.0
lastHostUuid String 3.10.0
instanceOfferingUuid String 计算规格UUID 3.10.0
rootVolumeUuid String 根云盘UUID 3.10.0
platform String 3.10.0
defaultL3NetworkUuid String 3.10.0
type String 3.10.0
hypervisorType String 3.10.0
memorySize Long 3.10.0
cpuNum Integer 3.10.0
cpuSpeed Long 3.10.0
allocatorStrategy String 3.10.0
createDate Timestamp 创建时间 3.10.0
lastOpDate Timestamp 最后一次修改时间 3.10.0
state String 3.10.0
vmNics List 详情参考vmNics 3.10.0
allVolumes List 详情参考allVolumes 3.10.0
#vmNics
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.10.0
vmInstanceUuid String 云主机UUID 3.10.0
l3NetworkUuid String 三层网络UUID 3.10.0
ip String ip地址 3.10.0
mac String mac地址 3.10.0
hypervisorType String 虚拟化类型 3.10.0
netmask String 子网掩码 3.10.0
gateway String 网关 3.10.0
metaData String 内部使用的保留域 3.10.0
ipVersion Integer IP地址版本 3.10.0
deviceId Integer 设备ID 3.10.0
createDate Timestamp 创建时间 3.10.0
lastOpDate Timestamp 最后一次修改时间 3.10.0
usedIps List 详情参考usedIps 3.10.0
#usedIps
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.10.0
ipRangeUuid String IP段UUID 3.10.0
l3NetworkUuid String 三层网络UUID 3.10.0
ipVersion Integer IP协议号 3.10.0
ip String IP地址 3.10.0
netmask String 网络掩码 3.10.0
gateway String 网关地址 3.10.0
usedFor String 3.10.0
ipInLong long 3.10.0
vmNicUuid String 云主机网卡UUID 3.10.0
createDate Timestamp 创建时间 3.10.0
lastOpDate Timestamp 最后一次修改时间 3.10.0
#allVolumes
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.10.0
name String 资源名称 3.10.0
description String 资源的详细描述 3.10.0
primaryStorageUuid String 主存储UUID 3.10.0
vmInstanceUuid String 云主机UUID 3.10.0
diskOfferingUuid String 云盘规格UUID 3.10.0
rootImageUuid String 云盘根镜像UUID 3.10.0
installPath String 云盘在主存储上的路径 3.10.0
type String 云盘类型，数据云盘/根云盘 3.10.0
format String 云盘格式 3.10.0
size Long 云盘大小 3.10.0
actualSize Long 云盘真实大小 3.10.0
deviceId Integer 3.10.0
state String 云盘是否开启 3.10.0
status String 云盘状态 3.10.0
createDate Timestamp 创建时间 3.10.0
lastOpDate Timestamp 最后一次修改时间 3.10.0
isShareable Boolean 是否共享云盘 3.10.0
volumeQos String 云盘Qos，格式如total=1048576 3.10.0

SDK示例

Java SDK
CreateVmInstanceFromVolumeAction action = new CreateVmInstanceFromVolumeAction();
action.name = "vm1";
action.description = "this is a vm";
action.instanceOfferingUuid = "80c606e35bc038bbb102e31cae191ea2";
action.l3NetworkUuids = asList("333817afcaf63f13a101f674761c8a77");
action.volumeUuid = "23984cd68b903fd4883aa962c70d83fc";
action.clusterUuid = "ada53eb6c42e34d3946ff1280718d9f2";
action.strategy = "InstantStart";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateVmInstanceFromVolumeAction.Result res = action.call();
Python SDK
CreateVmInstanceFromVolumeAction action = CreateVmInstanceFromVolumeAction()
action.name = "vm1"
action.description = "this is a vm"
action.instanceOfferingUuid = "80c606e35bc038bbb102e31cae191ea2"
action.l3NetworkUuids = [333817afcaf63f13a101f674761c8a77]
action.volumeUuid = "23984cd68b903fd4883aa962c70d83fc"
action.clusterUuid = "ada53eb6c42e34d3946ff1280718d9f2"
action.strategy = "InstantStart"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateVmInstanceFromVolumeAction.Result res = action.call()
上一篇创建云主机(CreateVmInstance)下一篇从快照创建云主机(CreateVmInstanceFromVolumeSnapshot)
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心