跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
POSTVM Related Interfaces起始版本 4.4.6同步需要认证

从OVF模板导入虚拟机

从OVF模板导入虚拟机

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • xmlBase64String必填

    资源名称。

  • jsonImageInfosString必填

    暂无描述。

  • backupStorageUuidString必填

    暂无描述。

  • jsonCreateVmParamString必填

    JSON字符串containing云主机creation参数。

  • deleteImageAfterSuccessboolean

    删除镜像文件成功部署。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • inventoryVmInstanceInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      数据中心UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • hostUuidString必填

      主机UUID

    • lastHostUuidString必填

      最近一次主机UUID。

    • instanceOfferingUuidString必填

      计算规格UUID

    • rootVolumeUuidString必填

      根硬盘UUID

    • platformString必填

      平台。

    • architectureString必填

      暂无描述。

    • defaultL3NetworkUuidString必填

      暂无描述。

    • typeString必填

      类型。

    • hypervisorTypeString必填

      暂无描述。

    • memorySizeLong必填

      内存大小。

    • cpuNumInteger必填

      暂无描述。

    • cpuSpeedLong必填

      暂无描述。

    • allocatorStrategyString必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      当前状态。

    • guestOsTypeString必填

      暂无描述。

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

        资源的UUID，唯一标示该资源

      • vmInstanceUuidString必填

        虚拟机UUID

      • l3NetworkUuidString必填

        分布式端口组UUID

      • ipString必填

        IP地址

      • macString必填

        MAC地址

      • hypervisorTypeString必填

        虚拟化类型

      • netmaskString必填

        子网掩码

      • gatewayString必填

        网关

      • metaDataString必填

        元数据。

      • ipVersionInteger必填

        IP地址版本

      • driverTypeString必填

        暂无描述。

      • internalNameString必填

        内部名称。

      • deviceIdInteger必填

        设备ID

      • typeString必填

        网卡类型

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • usedIpsList必填

        详情参考usedIps

        • uuidString必填

          资源的UUID，唯一标示该资源

        • ipRangeUuidString必填

          IP段UUID

        • l3NetworkUuidString必填

          分布式端口组UUID

        • ipVersionInteger必填

          IP协议号

        • ipString必填

          IP地址

        • netmaskString必填

          网络掩码

        • gatewayString必填

          网关地址

        • usedForString必填

          已使用用于。

        • ipInLonglong必填

          暂无描述。

        • vmNicUuidString必填

          虚拟机网卡UUID

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

    • allVolumesList必填

      详情参考allVolumes

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • primaryStorageUuidString必填

        数据存储UUID

      • vmInstanceUuidString必填

        虚拟机UUID

      • diskOfferingUuidString必填

        硬盘规格UUID

      • rootImageUuidString必填

        硬盘根镜像UUID

      • installPathString必填

        硬盘在数据存储上的路径

      • typeString必填

        硬盘类型，数据硬盘/根硬盘

      • formatString必填

        硬盘格式

      • sizeLong必填

        硬盘大小

      • actualSizeLong必填

        硬盘真实大小

      • deviceIdInteger必填

        设备ID。

      • stateString必填

        硬盘是否开启

      • statusString必填

        硬盘状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否共享硬盘

      • volumeQosString必填

        硬盘Qos，格式如total=1048576

    • vmCdRomsList必填

      详情参考vmCdRoms

      • uuidString必填

        资源的UUID，唯一标示该资源

      • vmInstanceUuidString必填

        虚拟机UUID

      • deviceIdInteger必填

        设备ID。

      • isoUuidString必填

        暂无描述。

      • isoInstallPathString必填

        iso安装路径。

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

POST/zstack/v1/ovf/create-vm-instance

/zstack/v1/ovf/create-vm-instance

操作 ID

CreateVmInstanceFromOvf

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/ovf/create-vm-instance' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"xmlBase64":"<xmlBase64>","jsonImageInfos":"<jsonImageInfos>","backupStorageUuid":"<backupStorageUuid>","jsonCreateVmParam":"<jsonCreateVmParam>","deleteImageAfterSuccess":true,"deleteImageOnFail":true,"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "ef8b74d3a7f931c3aacf258c20d25411", "name": "test-ovf", "description": "web server VM", "zoneUuid": "5f3cdedd4a823bfcadd45385f034b763", "clusterUuid": "2bb23d2c0a013338add7cedf2615ac39", "imageUuid": "f47e5dbf886e3d16b8097294efd63b37", "hostUuid": "82bad7cada82377684459e59292937b4", "lastHostUuid": "00e742c03afe3cd68234aa9c9352d5a7", "instanceOfferingUuid": "a9a166f625e23886a7227bdb472da645", "rootVolumeUuid": "3e92e577418835a3bfeb0d770e898052", "platform": "Linux", "defaultL3NetworkUuid": "e4f37ede6e563fe5943ae8b8c7c008d6", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 4.294967296E9, "cpuNum": 4.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM", "state": "Running", "vmNics": [ { "uuid": "d5a26fdfdcff30748b22b85f4d7fadbe", "vmInstanceUuid": "ef8b74d3a7f931c3aacf258c20d25411", "usedIpUuid": "4423412a12653cb3af73231e16e526cf", "l3NetworkUuid": "e4f37ede6e563fe5943ae8b8c7c008d6", "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 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } ], "allVolumes": [ { "uuid": "3e92e577418835a3bfeb0d770e898052", "name": "Root-Volume-For-VM-ef8b74d3a7f931c3aacf258c20d25411", "primaryStorageUuid": "353a440b83283acca73e3d3fd2cca0c5", "vmInstanceUuid": "ef8b74d3a7f931c3aacf258c20d25411", "diskOfferingUuid": "323969fdd2273f1a8e42aef10a9e8c6b", "rootImageUuid": "f47e5dbf886e3d16b8097294efd63b37", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-3e92e577418835a3bfeb0d770e898052/3e92e577418835a3bfeb0d770e898052.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史