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

解析OVF模板信息

解析OVF模板信息

调试可用性

在线调试

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

请求参数

请求体字段

  • xmlBase64String必填

    基础64编码ovf文件内容。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • ovfInfoOvfInfo必填

    详情参考ovfInfo

    • vmNameString必填

      虚拟机名称

    • disksList必填

      详情参考disks

      • indexint必填

        磁盘序号

      • diskIdString必填

        磁盘ID

      • fileRefString必填

        文件引用名称

      • fileNameString必填

        镜像文件名

      • formatString必填

        镜像文件格式

      • populatedSizeLong必填

        镜像文件大小

      • capacityLong必填

        磁盘容量，单位Byte

    • networksList必填

      详情参考networks

      • nameString必填

        网络名称

    • cpuOvfCpuInfo必填

      详情参考cpu

      • instanceIdString必填

        硬件ID

      • quantityInteger必填

        CPU内核数量

      • coresPerSocketInteger必填

        每CPU内核数

    • memoryOvfMemoryInfo必填

      详情参考memory

      • instanceIdString必填

        硬件ID

      • quantityLong必填

        内存容量，单位Byte

    • osOvfOSInfo必填

      详情参考os

      • idInteger必填

        操作系统ID

      • versionString必填

        操作系统版本

      • osTypeString必填

        操作系统类型

      • descriptionString必填

        操作系统描述

    • systemInfoOvfSystemInfo必填

      详情参考systemInfo

      • virtualSystemTypeString必填

        硬件系统类型

      • firmwareTypeString必填

        固件类型

    • nicsList必填

      详情参考nics

      • networkNameString必填

        网络名称

      • nicModelString必填

        网卡型号

      • nicNameString必填

        网卡名称

      • autoAllocationBoolean必填

        是否自动分配

    • cdDriversList必填

      详情参考cdDrivers

      • autoAllocationBoolean必填

        是否自动分配

      • driverTypeString必填

        光驱控制器类型

      • subTypeString必填

        子类型

      • nameString必填

        光驱名称

    • volumesList必填

      详情参考volumes

      • nameString必填

        磁盘名称

      • diskIdString必填

        磁盘ID

      • driverTypeString必填

        磁盘驱动器类型

请求地址

POST/zstack/v1/ovf/parse

/zstack/v1/ovf/parse

操作 ID

ParseOvf

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/ovf/parse' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"xmlBase64":"<xmlBase64>","systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "ovfInfo": { "disks": [ { "index": 0.0, "diskId": "system", "fileRef": "file1", "fileName": "system.vmdk", "format": "vmdk", "populatedSize": 1.688600576E9, "capacity": 6.442450944E10 } ], "networks": [ { "name": "red-net" } ], "cpu": { "instanceId": "2", "quantity": 4.0, "coresPerSocket": 4.0 }, "memory": { "instanceId": "3", "quantity": 4.294967296E9 }, "vmName": "VM-1", "os": { "id": 107.0, "version": "7", "osType": "centos", "description": "CentOS 7" }, "systemInfo": { "virtualSystemType": "vmx-18" }, "nics": [ { "networkName": "red-net", "nicModel": "E1000", "nicName": "nic-1", "autoAllocation": true } ], "cdDrivers": [ { "autoAllocation": true, "driverType": "SATA", "subType": "vmware.cdrom.remotepassthrough", "name": "CD" } ], "volumes": [ { "name": "System Volume", "diskId": "system", "driverType": "IDE" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史