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

导出虚拟机的OVA包

导出虚拟机的OVA包

调试可用性

在线调试

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

请求参数

请求体字段

  • nameString

    资源名称。

  • descriptionString

    资源的详细描述。

  • vmUuidString必填

    云主机UUID。

  • backupStorageUuidString必填

    暂无描述。

  • resourceUuidString

    资源UUID。若指定，资源会使用该字段值作为UUID。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVmInstanceInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • vmUuidString必填

      源虚拟机UUID

    • backupStorageUuidString必填

      镜像包文件位于的镜像存储UUID

    • exportUrlString必填

      下载地址

    • md5SumString必填

      镜像包文件MD5校验码

    • formatString必填

      镜像包文件格式

    • sizeLong必填

      镜像包文件大小

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateImagePackageState必填

      详情参考state

      • ExportingImagePackageState必填

        导出中

      • ExportedImagePackageState必填

        已导出

请求地址

POST/zstack/v1/ovf/ova-packages

/zstack/v1/ovf/ova-packages

操作 ID

ExportVmOvaPackage

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/ovf/ova-packages' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"name":"<name>","description":"<description>","vmUuid":"<vmUuid>","backupStorageUuid":"<backupStorageUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "9f77f8d79ee138bfac21290c02fc2cb6", "name": "ova", "description": "description", "vmUuid": "43d306a42cdf38c48458d061e40b810a", "backupStorageUuid": "22f7145dba4f3da6af7ff8f0e02af6e3", "state": "Exported", "exportUrl": "http://bs-host-name/path/to/ova.ova", "md5Sum": "sampleMd5Sum", "format": "OVA", "size": 1.073741824E10, "createDate": "May 10, 2022 5:24:03 AM", "lastOpDate": "May 10, 2022 5:24:03 AM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史