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

获取候选镜像列表

获取用于修改云主机根云盘的候选镜像列表。

GET/zstack/v1/vm-instances/{vmInstanceUuid}/image-candidates

操作 ID

GetImageCandidatesForVmToChange

起始版本

2.2

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • vmInstanceUuid
    String

    云主机UUID

查询参数

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventories
    List必填

    详情参考inventories

    • uuid
      String必填

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

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • state
      String必填

      当前状态。

    • status
      String必填

      状态信息。

    • size
      Long必填

      返回记录数。

    • actualSize
      Long必填

      实际大小。

    • md5Sum
      String必填

      暂无描述。

    • url
      String必填

      暂无描述。

    • mediaType
      String必填

      media类型。

    • guestOsType
      String必填

      guest操作系统类型。

    • type
      String必填

      类型。

    • platform
      String必填

      平台。

    • format
      String必填

      数据格式或导出格式。

    • system
      Boolean必填

      系统。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • backupStorageRefs
      List必填

      详情参考backupStorageRefs

      • imageUuid
        String必填

        镜像UUID

      • backupStorageUuid
        String必填

        镜像存储UUID

      • installPath
        String必填

        安装路径。

      • exportUrl
        String必填

        导出地址。

      • exportMd5Sum
        String必填

        导出md 5求和。

      • status
        String必填

        状态信息。

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间