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

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

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth: a2a9ac093ee64f669665aff2807bbe8a" \
-X GET http://localhost:8080/zstack/v1/vm-instances/d8cfc97f5099454bb3eed367a79d4e4c/starting-target-hosts

参数列表


名字	类型	位置	描述	起始版本
uuid	String	url	云主机UUID	0.6
systemTags (可选)	List	query	系统标签	0.6
userTags (可选)	List	query	用户标签	0.6

API返回

返回示例

{
  "hostInventories": [
    {
      "zoneUuid": "1650e7c372ab4d43aa1b16e3a48f5f05",
      "name": "example",
      "uuid": "3b659b741cc743a5840aaab5a2c366d1",
      "clusterUuid": "5ecdcc0a2823494daa0c85a7889a7890",
      "description": "example",
      "managementIp": "192.168.0.1",
      "hypervisorType": "KVM",
      "state": "Enabled",
      "status": "Connected",
      "totalCpuCapacity": 4.0,
      "availableCpuCapacity": 2.0,
      "totalMemoryCapacity": 4.0,
      "availableMemoryCapacity": 4.0,
      "createDate": "Apr 24, 2017 7:11:02 PM",
      "lastOpDate": "Apr 24, 2017 7:11:02 PM"
    }
  ],
  "clusterInventories": [
    {
      "name": "cluster1",
      "uuid": "2ecd7d0ddad649e4a36a7f47e43dae1a",
      "hypervisorType": "KVM",
      "createDate": "Apr 24, 2017 7:11:02 PM",
      "lastOpDate": "Apr 24, 2017 7:11:02 PM",
      "zoneUuid": "268a180f9a7d4ebe9f5a0e7ad558d523"
    }
  ]
}


名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
hosts	List	详情参考hosts	0.6
clusters	List	详情参考clusters	0.6

#error


名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#hosts


名字	类型	描述	起始版本
zoneUuid	String	区域UUID	0.6
name	String	资源名称	0.6
uuid	String	资源的UUID，唯一标示该资源	0.6
clusterUuid	String	集群UUID	0.6
description	String	资源的详细描述	0.6
managementIp	String		0.6
hypervisorType	String		0.6
state	String		0.6
status	String		0.6
totalCpuCapacity	Long		0.6
availableCpuCapacity	Long		0.6
cpuSockets	Integer		0.6
totalMemoryCapacity	Long		0.6
availableMemoryCapacity	Long		0.6
cpuNum	Integer		0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

#clusters


名字	类型	描述	起始版本
name	String	资源名称	0.6
uuid	String	资源的UUID，唯一标示该资源	0.6
description	String	资源的详细描述	0.6
state	String	集群状态	0.6
hypervisorType	String	虚拟机管理程序类型	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
zoneUuid	String	区域UUID	0.6
type	String	保留域	0.6

SDK示例

Java SDK

GetVmStartingCandidateClustersHostsAction action = new GetVmStartingCandidateClustersHostsAction();
action.uuid = "a591b94c66d6452284f9940e7807425a";
action.sessionId = "5630397e6ade47e9bd73569f5177957e";
GetVmStartingCandidateClustersHostsAction.Result res = action.call();

Python SDK

GetVmStartingCandidateClustersHostsAction action = GetVmStartingCandidateClustersHostsAction()
action.uuid = "0cb8127bcfb8431497562f7464ee9920"
action.sessionId = "9320fb483c3c4926a7870ffa045088b2"
GetVmStartingCandidateClustersHostsAction.Result res = action.call()