跳转到主要内容
ZStack
资源中心/云资源池/镜像相关接口

添加镜像

向镜像服务器添加镜像。

POST/zstack/v1/images

操作 ID

AddImage

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • name
      String必填

      镜像名称

    • description
      String

      镜像的详细描述

    • url
      String必填

      被添加镜像的URL地址

    • mediaType
      String

      镜像的类型

    • guestOsType
      String

      镜像对应客户机操作系统的类型

    • system
      boolean

      是否系统镜像

    • format
      String

      镜像的格式，比如：raw

    • platform
      String

      镜像的系统平台

    • backupStorageUuids
      List必填

      指定添加镜像的镜像服务器UUID列表

    • type
      String

      内部使用字段

    • resourceUuid
      String

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

    • architecture
      String

      可选。

    • tagUuids
      List

      标签UUID列表

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventory
    ImageInventory必填

    详情参考inventory

    • uuid
      String必填

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

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • state
      String必填

      镜像的启动状态

    • status
      String必填

      镜像的就绪状态

    • size
      Long必填

      镜像大小

    • actualSize
      Long必填

      镜像真实容量

    • md5Sum
      String必填

      镜像的md5值

    • url
      String必填

      镜像的URL地址

    • mediaType
      String必填

      镜像的类型

    • guestOsType
      String必填

      镜像对应的客户机操作系统类型

    • type
      String必填

      内部使用字段

    • platform
      String必填

      镜像的系统平台

    • architecture
      String必填

      镜像CPU架构

    • format
      String必填

      镜像的格式，比如：raw

    • system
      Boolean必填

      标识是否为系统镜像

    • virtio
      Boolean必填

      是否支持virtio

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • backupStorageRefs
      List必填

      详情参考backupStorageRefs

      • imageUuid
        String必填

        镜像UUID

      • backupStorageUuid
        String必填

        镜像存储UUID

      • installPath
        String必填

        在镜像服务器上的安装路径

      • exportUrl
        String必填

        导出镜像的url

      • exportMd5Sum
        String必填

        导出镜像的md5值

      • status
        String必填

        镜像就绪状态

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间