虚拟机相关接口

创建FT虚拟机

POST/zstack/v1/vm-instances/fault-tolerance

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "vm1",
    "instanceOfferingUuid": "e7f7da783e573c7ebc3859e2d16552f3",
    "imageUuid": "de06f83941db39ad805e51631319934a",
    "l3NetworkUuids": [
      "54f599b8cc84319e926c2a87a9aa69f3"
    ],
    "dataDiskOfferingUuids": [
      "515287814adc30b0ac62ca9404850d3a",
      "eb016f64ac4234fbbeaea24cd35ac3c4"
    ],
    "clusterUuid": "ee25403505453f4b91fc090dd7ca0a98",
    "description": "this is a vm",
    "strategy": "InstantStart",
    "type": "FaultToleranceVmGroup"
  },
  "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","instanceOfferingUuid":"e7f7da783e573c7ebc3859e2d16552f3","imageUuid":"de06f83941db39ad805e51631319934a","l3NetworkUuids":["54f599b8cc84319e926c2a87a9aa69f3"],"dataDiskOfferingUuids":["515287814adc30b0ac62ca9404850d3a","eb016f64ac4234fbbeaea24cd35ac3c4"],"clusterUuid":"ee25403505453f4b91fc090dd7ca0a98","description":"this is a vm","strategy":"InstantStart","type":"FaultToleranceVmGroup"}}' \
http://localhost:8080/zstack/v1/vm-instances/fault-tolerance

参数列表

名字类型位置描述可选值起始版本
nameStringbody(包含在params结构中)资源名称 3.9.0
instanceOfferingUuid (可选)Stringbody(包含在params结构中)计算规格UUID 3.9.0
cpuNum (可选)Integerbody(包含在params结构中)  3.9.0
memorySize (可选)Longbody(包含在params结构中)  3.9.0
imageUuidStringbody(包含在params结构中)镜像UUID 3.9.0
l3NetworkUuidsListbody(包含在params结构中)  3.9.0
dataDiskOfferingUuids (可选)Listbody(包含在params结构中)  3.9.0
zoneUuid (可选)Stringbody(包含在params结构中)数据中心UUID 3.9.0
clusterUuid (可选)Stringbody(包含在params结构中)集群UUID 3.9.0
hostUuid (可选)Stringbody(包含在params结构中)主机UUID 3.9.0
primaryStorageUuidForRootVolume (可选)Stringbody(包含在params结构中)  3.9.0
description (可选)Stringbody(包含在params结构中)资源的详细描述 3.9.0
defaultL3NetworkUuid (可选)Stringbody(包含在params结构中)  3.9.0
rootVolumeSystemTags (可选)Listbody(包含在params结构中)  3.9.0
dataVolumeSystemTags (可选)Listbody(包含在params结构中)  3.9.0
resourceUuid (可选)Stringbody(包含在params结构中)  3.9.0
tagUuids (可选)Listbody(包含在params结构中)标签UUID列表 3.9.0
systemTags (可选)Listbody  3.9.0
userTags (可选)Listbody  3.9.0
strategy (可选)Stringbody(包含在params结构中)  0.6
type (可选)Stringbody(包含在params结构中)  0.6

API返回

返回示例

{
  "primaryVmInventory": {
    "uuid": "2d62fd64016b3e1297efed88bfee8f3d",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "d63f4978a99b3911a79b8298660658da",
    "clusterUuid": "8c61901b64a2371abe0c9be588343da9",
    "imageUuid": "86de69d705e538f7b0a94f63f13f5e63",
    "hostUuid": "b6137d47d5ca34b7b67c2f88b1661bf0",
    "lastHostUuid": "80265be7bebe336eb87eee4f96fb41fb",
    "instanceOfferingUuid": "f6a0ef68fe7b332ea2a8b1e08ecc142a",
    "rootVolumeUuid": "d8be99a7405b38a98c066003daa0e515",
    "platform": "Linux",
    "defaultL3NetworkUuid": "53655a79af73382f87c5ff5010a1c4cc",
    "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": "d8be99a7405b38a98c066003daa0e515",
        "name": "Root-Volume-For-VM-2d62fd64016b3e1297efed88bfee8f3d",
        "primaryStorageUuid": "ab385e443b3e3356b12ea36f81e0ffde",
        "vmInstanceUuid": "2d62fd64016b3e1297efed88bfee8f3d",
        "diskOfferingUuid": "8b03e36ce93b37dbb2825df535572700",
        "rootImageUuid": "86de69d705e538f7b0a94f63f13f5e63",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-d8be99a7405b38a98c066003daa0e515/d8be99a7405b38a98c066003daa0e515.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"
      }
    ]
  },
  "secondaryVmInventory": {
    "uuid": "5a6d990017e2324397fc89974351dbd5",
    "name": "Test-svm",
    "description": "web server svm",
    "zoneUuid": "cb4ec84375e0396597f86f8472fa0217",
    "clusterUuid": "19bf28a642733c7f8a09767255eb88ab",
    "imageUuid": "8f8a5f8e99293536862bf44b0e8e4a06",
    "hostUuid": "e0d755850cf637df8f7af1004222930d",
    "lastHostUuid": "190c220ae2323388aa9b6917f6b8608f",
    "instanceOfferingUuid": "ae9f7726ec1438fcb87574a212bd9f99",
    "rootVolumeUuid": "d8be99a7405b38a98c066003daa0e515",
    "platform": "Linux",
    "defaultL3NetworkUuid": "53655a79af73382f87c5ff5010a1c4cc",
    "type": "FaultToleranceVmGroup",
    "hypervisorType": "Ksvm",
    "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": "d8be99a7405b38a98c066003daa0e515",
        "name": "Root-Volume-For-VM-2d62fd64016b3e1297efed88bfee8f3d",
        "primaryStorageUuid": "2f69982e2e91358abd3761dc9f4799a2",
        "vmInstanceUuid": "2d62fd64016b3e1297efed88bfee8f3d",
        "diskOfferingUuid": "3a3f0cc999ed3a379b0cd5e5900ac639",
        "rootImageUuid": "86de69d705e538f7b0a94f63f13f5e63",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-d8be99a7405b38a98c066003daa0e515/d8be99a7405b38a98c066003daa0e515.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"
      }
    ]
  },
  "faultToleranceVmGroupInventory": {
    "uuid": "b5428087c53939b9a0b85e322f1e7bb6",
    "name": "Test-ftVm",
    "description": "web server ftVm",
    "zoneUuid": "b441a4f72ac23f92be85f951a54b8ea7",
    "clusterUuid": "618e159139003cf1971132ec1f426456",
    "imageUuid": "4e57cd7ee15932e68eb87a7d1f9b03e0",
    "hostUuid": "6a849cdc9f8f359ba9d878e21fc18a15",
    "lastHostUuid": "24fcefebc2af3f61a8caecd2fd2cef2b",
    "instanceOfferingUuid": "04d2247fafbd3ba2a64d367f69b2d402",
    "rootVolumeUuid": "d8be99a7405b38a98c066003daa0e515",
    "platform": "Linux",
    "defaultL3NetworkUuid": "53655a79af73382f87c5ff5010a1c4cc",
    "type": "FaultToleranceVmGroup",
    "hypervisorType": "KftVm",
    "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": "e7be04a3db4f31ee9fd35feda0b9e3f6",
        "vmInstanceUuid": "2d62fd64016b3e1297efed88bfee8f3d",
        "usedIpUuid": "2baea67e32473aff96a40735735587ba",
        "l3NetworkUuid": "53655a79af73382f87c5ff5010a1c4cc",
        "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": "d8be99a7405b38a98c066003daa0e515",
        "name": "Root-Volume-For-VM-2d62fd64016b3e1297efed88bfee8f3d",
        "primaryStorageUuid": "8a1c7e7eae623b3c827cee8679c03d85",
        "vmInstanceUuid": "2d62fd64016b3e1297efed88bfee8f3d",
        "diskOfferingUuid": "4fe96d078ecf3e94b69c6898e53131e0",
        "rootImageUuid": "86de69d705e538f7b0a94f63f13f5e63",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-d8be99a7405b38a98c066003daa0e515/d8be99a7405b38a98c066003daa0e515.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请求是否成功4.10.16
errorErrorCode详情参考error4.10.16
primaryVmInventoryVmInstanceInventory详情参考primaryVmInventory3.9.0
secondaryVmInventoryShadowVmInstanceInventory详情参考secondaryVmInventory3.9.0

error

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

primaryVmInventory

名字类型描述起始版本
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计算规格 UUID, 已废弃0.6
rootVolumeUuidString根硬盘 UUID0.6
platformString虚拟机的平台, 是 Windows / Linux 还是其它0.6
architectureString虚拟机架构, 是 x86_64 / aarch64 还是其它0.6
defaultL3NetworkUuidString默认使用的分布式端口组 UUID0.6
typeString虚拟机类型, 是用户使用虚拟机还是平台特殊用途的虚拟机0.6
hypervisorTypeString虚拟机虚拟化类型, 一般为 KVM0.6
memorySizeLong内存大小0.6
cpuNumIntegerCPU 数量0.6
cpuSpeedLongCPU 速度0.6
allocatorStrategyString虚拟机分配策略0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
stateString虚拟机是否启用的状态0.6
guestOsTypeString虚拟机宿主操作系统类型3.11.2
vmNicsList详情参考vmNics0.6
allVolumesList详情参考allVolumes0.6
vmCdRomsList详情参考vmCdRoms0.6

vmNics

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.17.13
vmInstanceUuidString虚拟机UUID3.17.13
l3NetworkUuidString分布式端口组UUID3.17.13
ipString 3.17.13
macString 3.17.13
hypervisorTypeString 3.17.13
netmaskString 3.17.13
gatewayString 3.17.13
metaDataString 3.17.13
ipVersionInteger 3.17.13
driverTypeString 3.17.13
internalNameString 3.17.13
deviceIdInteger 3.17.13
typeString 3.17.13
stateString网卡状态3.17.13
createDateTimestamp创建时间3.17.13
lastOpDateTimestamp最后一次修改时间3.17.13
usedIpsList详情参考usedIps3.17.13

usedIps

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.10.0
ipRangeUuidStringIP段UUID4.10.0
l3NetworkUuidString分布式端口组UUID4.10.0
ipVersionIntegerIP协议号4.10.0
ipStringIP地址4.10.0
netmaskString子网掩码4.10.0
gatewayString网关地址4.10.0
usedForString分配原因4.10.0
ipInLonglongLong存储的IP地址，仅ipv4有效4.10.0
vmNicUuidString虚拟机网卡UUID4.10.0
createDateTimestamp创建时间4.10.0
lastOpDateTimestamp最后一次修改时间4.10.0

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.17.13
nameString资源名称3.17.13
descriptionString资源的详细描述3.17.13
primaryStorageUuidString数据存储UUID3.17.13
vmInstanceUuidString虚拟机UUID3.17.13
diskOfferingUuidString硬盘规格UUID3.17.13
rootImageUuidString 3.17.13
installPathString 3.17.13
typeString 3.17.13
formatString 3.17.13
sizeLong 3.17.13
actualSizeLong 3.17.13
deviceIdInteger 3.17.13
stateString 3.17.13
statusString 3.17.13
createDateTimestamp创建时间3.17.13
lastOpDateTimestamp最后一次修改时间3.17.13
isShareableBoolean 3.17.13
volumeQosString 3.17.13
lastDetachDateTimestamp 3.17.13
lastVmInstanceUuidString 3.17.13

vmCdRoms

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.17.13
vmInstanceUuidString虚拟机UUID3.17.13
deviceIdInteger 3.17.13
isoUuidString 3.17.13
isoInstallPathString 3.17.13
nameString资源名称3.17.13
descriptionString资源的详细描述3.17.13
createDateTimestamp创建时间3.17.13
lastOpDateTimestamp最后一次修改时间3.17.13

secondaryVmInventory

名字类型描述起始版本
primaryVmInstanceUuidString 0.6
secondaryVmInstanceUuidString 0.6
statusString 0.6
uuidString资源的UUID，唯一标示该资源0.6
nameString资源名称0.6
descriptionString资源的详细描述0.6
zoneUuidString数据中心UUID0.6
clusterUuidString集群UUID0.6
imageUuidString镜像UUID0.6
hostUuidString主机UUID0.6
lastHostUuidString 0.6
instanceOfferingUuidString计算规格UUID0.6
rootVolumeUuidString根硬盘UUID0.6
platformString 0.6
defaultL3NetworkUuidString 0.6
typeString 0.6
hypervisorTypeString 0.6
memorySizeLong 0.6
cpuNumInteger 0.6
cpuSpeedLong 0.6
allocatorStrategyString 0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
stateString 0.6
vmNicsList详情参考vmNics0.6
allVolumesList详情参考allVolumes0.6
vmCdRomsList详情参考vmCdRoms0.6

vmNics

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.17.13
vmInstanceUuidString虚拟机UUID3.17.13
l3NetworkUuidString分布式端口组UUID3.17.13
ipString 3.17.13
macString 3.17.13
hypervisorTypeString 3.17.13
netmaskString 3.17.13
gatewayString 3.17.13
metaDataString 3.17.13
ipVersionInteger 3.17.13
driverTypeString 3.17.13
internalNameString 3.17.13
deviceIdInteger 3.17.13
typeString 3.17.13
stateString网卡状态3.17.13
createDateTimestamp创建时间3.17.13
lastOpDateTimestamp最后一次修改时间3.17.13
usedIpsList详情参考usedIps3.17.13

usedIps

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.10.0
ipRangeUuidStringIP段UUID4.10.0
l3NetworkUuidString分布式端口组UUID4.10.0
ipVersionIntegerIP协议号4.10.0
ipStringIP地址4.10.0
netmaskString子网掩码4.10.0
gatewayString网关地址4.10.0
usedForString分配原因4.10.0
ipInLonglongLong存储的IP地址，仅ipv4有效4.10.0
vmNicUuidString虚拟机网卡UUID4.10.0
createDateTimestamp创建时间4.10.0
lastOpDateTimestamp最后一次修改时间4.10.0

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.17.13
nameString资源名称3.17.13
descriptionString资源的详细描述3.17.13
primaryStorageUuidString数据存储UUID3.17.13
vmInstanceUuidString虚拟机UUID3.17.13
diskOfferingUuidString硬盘规格UUID3.17.13
rootImageUuidString 3.17.13
installPathString 3.17.13
typeString 3.17.13
formatString 3.17.13
sizeLong 3.17.13
actualSizeLong 3.17.13
deviceIdInteger 3.17.13
stateString 3.17.13
statusString 3.17.13
createDateTimestamp创建时间3.17.13
lastOpDateTimestamp最后一次修改时间3.17.13
isShareableBoolean 3.17.13
volumeQosString 3.17.13
lastDetachDateTimestamp 3.17.13
lastVmInstanceUuidString 3.17.13

vmCdRoms

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源3.17.13
vmInstanceUuidString虚拟机UUID3.17.13
deviceIdInteger 3.17.13
isoUuidString 3.17.13
isoInstallPathString 3.17.13
nameString资源名称3.17.13
descriptionString资源的详细描述3.17.13
createDateTimestamp创建时间3.17.13
lastOpDateTimestamp最后一次修改时间3.17.13

SDK示例

Java SDK

CreateFaultToleranceVmInstanceAction action = new CreateFaultToleranceVmInstanceAction();
action.name = "vm1";
action.instanceOfferingUuid = "e7f7da783e573c7ebc3859e2d16552f3";
action.imageUuid = "de06f83941db39ad805e51631319934a";
action.l3NetworkUuids = asList("54f599b8cc84319e926c2a87a9aa69f3");
action.dataDiskOfferingUuids = asList("515287814adc30b0ac62ca9404850d3a","eb016f64ac4234fbbeaea24cd35ac3c4");
action.clusterUuid = "ee25403505453f4b91fc090dd7ca0a98";
action.description = "this is a vm";
action.strategy = "InstantStart";
action.type = "FaultToleranceVmGroup";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateFaultToleranceVmInstanceAction.Result res = action.call();

Python SDK

action = CreateFaultToleranceVmInstanceAction()
action.name = "vm1"
action.instanceOfferingUuid = "e7f7da783e573c7ebc3859e2d16552f3"
action.imageUuid = "de06f83941db39ad805e51631319934a"
action.l3NetworkUuids = [54f599b8cc84319e926c2a87a9aa69f3]
action.dataDiskOfferingUuids = [515287814adc30b0ac62ca9404850d3a, eb016f64ac4234fbbeaea24cd35ac3c4]
action.clusterUuid = "ee25403505453f4b91fc090dd7ca0a98"
action.description = "this is a vm"
action.strategy = "InstantStart"
action.type = "FaultToleranceVmGroup"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET查询虚拟机设备地址组

上一页

POST创建虚拟机自定义操作系统规范

下一页