获取虚拟机可启动目的地列表

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

该 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
hosts
List必填
详情参考hosts
- zoneUuid
  String必填
  数据中心UUID
- name
  String必填
  资源名称
- uuid
  String必填
  资源的UUID，唯一标示该资源
- clusterUuid
  String必填
  集群UUID
- description
  String必填
  资源的详细描述
- managementIp
  String必填
  管理IP。
- hypervisorType
  String必填
  暂无描述。
- state
  String必填
  当前状态。
- status
  String必填
  状态信息。
- totalCpuCapacity
  Long必填
  总CPU容量。
- availableCpuCapacity
  Long必填
  可用CPU容量。
- cpuSockets
  Integer必填
  物理CPU插槽数量
- totalMemoryCapacity
  Long必填
  总内存容量。
- availableMemoryCapacity
  Long必填
  可用内存容量。
- cpuNum
  Integer必填
  暂无描述。
- ipmiAddress
  String必填
  IPMI地址
- ipmiUsername
  String必填
  IPMI用户名
- ipmiPort
  Integer必填
  IPMI端口
- ipmiPowerStatus
  String必填
  IPMI电源状态
- architecture
  String必填
  暂无描述。
- nqn
  String必填
  NVMe 限定名称
- hostname
  String必填
  主机名
- createDate
  Timestamp必填
  创建时间
- lastOpDate
  Timestamp必填
  最后一次修改时间
- cpuStatus
  HwMonitorStatus必填
  详情参考cpuStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- memoryStatus
  HwMonitorStatus必填
  详情参考memoryStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- diskStatus
  HwMonitorStatus必填
  详情参考diskStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- nicStatus
  HwMonitorStatus必填
  详情参考nicStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- gpuStatus
  HwMonitorStatus必填
  详情参考gpuStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- powerSupplyStatus
  HwMonitorStatus必填
  详情参考powerSupplyStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- fanStatus
  HwMonitorStatus必填
  详情参考fanStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- raidStatus
  HwMonitorStatus必填
  详情参考raidStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
- temperatureStatus
  HwMonitorStatus必填
  详情参考temperatureStatus
  Normal
  HwMonitorStatus必填
  正常
  Error
  HwMonitorStatus必填
  异常
  Unknown
  HwMonitorStatus必填
  未知
clusters
List必填
详情参考clusters
- name
  String必填
  资源名称
- uuid
  String必填
  资源的UUID，唯一标示该资源
- description
  String必填
  资源的详细描述
- state
  String必填
  集群状态
- hypervisorType
  String必填
  虚拟机管理程序类型
- createDate
  Timestamp必填
  创建时间
- lastOpDate
  Timestamp必填
  最后一次修改时间
- zoneUuid
  String必填
  数据中心UUID
- type
  String必填
  保留域

变更历史

此 API 暂无变更历史记录。

查看全部变更历史

请求示例

curl -X GET '{host}/zstack/v1/vm-instances/{uuid}/starting-target-hosts?systemTags={systemTags}&userTags={userTags}' \
  -H 'Authorization: Bearer {token}'

响应示例

{
  "hostInventories": [
    {
      "zoneUuid": "d876132a577135729b0d9c6a3913b66d",
      "name": "example",
      "uuid": "690fe2a9e75d3cd89697b4bc9de615e7",
      "clusterUuid": "cadc7dac02873192bf76262f86e57fb4",
      "description": "example",
      "managementIp": "192.168.0.1",
      "hypervisorType": "KVM",
      "state": "Enabled",
      "status": "Connected",
      "totalCpuCapacity": 4,
      "availableCpuCapacity": 2,
      "totalMemoryCapacity": 4,
      "availableMemoryCapacity": 4,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ],
  "clusterInventories": [
    {
      "name": "cluster1",
      "uuid": "a7036593626b3d418ff55f9a767aec58",
      "hypervisorType": "KVM",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "zoneUuid": "faa41ed7d0a53cae99ff2a6d2c5d55dc"
    }
  ]
}

数据中心相关接口

集群相关接口

主机相关接口

主机硬件设备相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

Kernel适配器相关接口

镜像存储相关接口

镜像相关接口

本地镜像仓库相关接口

分布式镜像仓库相关接口

虚拟机相关接口

密钥提供程序相关接口

vTPM相关接口

裸金属模板相关接口

裸金属集群相关接口

裸金属设备相关接口

裸金属主机相关接口

裸金属网络相关接口

数据存储相关接口

本地存储相关接口

NFS存储相关接口

分布式存储相关接口

SAN存储相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

分布式交换机相关接口

分布式端口组相关接口

网络服务

安全组相关接口

管理节点监控相关接口

动态资源调度策略相关接口

虚拟机调度策略相关接口

高可用策略相关接口

快照相关接口

备份管理相关接口

CBT相关接口

监控报警相关接口

通知服务相关接口

容量管理相关接口

时序数据(Metric)

任务

事件(Event)

报警器(Alarm)

事件订阅(Event Subscription)

报警文本模板(Text Template)

审计

标签相关接口

自定义属性相关接口

迁移服务相关接口

用户配置相关接口

统一认证服务器相关接口

控制台代理相关接口

AccessKey管理相关接口

IP黑白名单相关接口

安全设置相关接口

日志服务器相关接口

SNMP相关接口

时间管理相关接口

系统参数相关接口

资源高级设置相关接口

进度条相关接口

查询可用资源相关接口

垃圾回收相关接口

许可证相关接口

长时任务相关接口

错误码相关接口

搜索相关接口

认证信息

请求参数

路径参数

查询参数

响应状态

变更历史