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

获取云主机可启动目的地列表

获取一个停止的云主机可以启动的集群、物理机列表。用户可以用该API判断一个停止的云主机可以在哪些集群、物理机上启动。

GET/zstack/v1/vm-instances/{uuid}/starting-target-hosts

操作 ID

GetVmStartingCandidateClustersHosts

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • uuid
    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

  • hosts
    List必填

    详情参考hosts

    • zoneUuid
      String必填

      区域UUID

    • name
      String必填

      资源名称

    • uuid
      String必填

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

    • clusterUuid
      String必填

      集群UUID

    • description
      String必填

      资源的详细描述

    • managementIp
      String必填

      管理IP。

    • hypervisorType
      String必填

      hypervisor类型。

    • state
      String必填

      当前状态。

    • status
      String必填

      状态信息。

    • totalCpuCapacity
      Long必填

      总CPU容量。

    • availableCpuCapacity
      Long必填

      可用CPU容量。

    • cpuSockets
      Integer必填

      暂无描述。

    • totalMemoryCapacity
      Long必填

      总内存容量。

    • availableMemoryCapacity
      Long必填

      可用内存容量。

    • cpuNum
      Integer必填

      暂无描述。

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

  • clusters
    List必填

    详情参考clusters

    • name
      String必填

      资源名称

    • uuid
      String必填

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

    • description
      String必填

      资源的详细描述

    • state
      String必填

      集群状态

    • hypervisorType
      String必填

      虚拟机管理程序类型

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • zoneUuid
      String必填

      区域UUID

    • type
      String必填

      保留域