跳转到主要内容
ZStack
资源中心/硬件设施/主存储相关接口

获取存储迁移候选列表

获取跨主存储迁移云主机候选主存储列表。

GET/zstack/v1/vm-instances/{vmInstanceUuid}/storage-migration-candidates

操作 ID

GetPrimaryStorageCandidatesForVmMigration

起始版本

3.1.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • vmInstanceUuid
    String必填

    云主机UUID

查询参数

  • systemTags
    List

    系统标签。

  • userTags
    List

    用户标签。

请求体字段

  • primaryStorageMigrateVm
    Object必填

    primaryStorageMigrateVm 请求体结构

    • withDataVolumes
      boolean

      暂无描述。

    • migrateStorageOnly
      boolean

      是否仅迁移存储

响应状态

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，唯一标示该资源

    • zoneUuid
      String必填

      区域UUID

    • name
      String必填

      资源名称

    • url
      String必填

      暂无描述。

    • description
      String必填

      资源的详细描述

    • totalCapacity
      Long必填

      总容量。

    • availableCapacity
      Long必填

      可用容量。

    • totalPhysicalCapacity
      Long必填

      总物理容量。

    • availablePhysicalCapacity
      Long必填

      可用物理容量。

    • systemUsedCapacity
      Long必填

      系统已使用容量。

    • type
      String必填

      类型。

    • state
      String必填

      当前状态。

    • status
      String必填

      状态信息。

    • mountPath
      String必填

      mount路径。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • attachedClusterUuids
      List必填

      暂无描述。