虚拟机相关接口

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

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

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

Headers

Authorization: OAuth the-session-uuid

Curl示例

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

参数列表

名字类型位置描述可选值起始版本
uuidStringurl虚拟机UUID 0.6
systemTags (可选)Listquery系统标签 0.6
userTags (可选)Listquery用户标签 0.6

API返回

返回示例

{
  "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"
    }
  ]
}
名字类型描述起始版本
successboolean 0.6
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error0.6
hostsList详情参考hosts0.6
clustersList详情参考clusters0.6

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段,默认为null0.6
opaqueLinkedHashMap保留字段,默认为null0.6
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null0.6

hosts

名字类型描述起始版本
zoneUuidString数据中心UUID0.6
nameString资源名称0.6
uuidString资源的UUID,唯一标示该资源0.6
clusterUuidString集群UUID0.6
descriptionString资源的详细描述0.6
managementIpString 0.6
hypervisorTypeString 0.6
stateString 0.6
statusString 0.6
totalCpuCapacityLong 0.6
availableCpuCapacityLong 0.6
cpuSocketsInteger物理CPU插槽数量0.6
totalMemoryCapacityLong 0.6
availableMemoryCapacityLong 0.6
cpuNumInteger 0.6
ipmiAddressStringIPMI地址0.6
ipmiUsernameStringIPMI用户名0.6
ipmiPortIntegerIPMI端口0.6
ipmiPowerStatusStringIPMI电源状态0.6
architectureString 0.6
nqnStringNVMe 限定名称4.10.6
hostnameString主机名4.10.20
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
cpuStatusHwMonitorStatus详情参考cpuStatus4.10.0
memoryStatusHwMonitorStatus详情参考memoryStatus4.10.0
diskStatusHwMonitorStatus详情参考diskStatus4.10.0
nicStatusHwMonitorStatus详情参考nicStatus4.10.0
gpuStatusHwMonitorStatus详情参考gpuStatus4.10.0
powerSupplyStatusHwMonitorStatus详情参考powerSupplyStatus4.10.0
fanStatusHwMonitorStatus详情参考fanStatus4.10.0
raidStatusHwMonitorStatus详情参考raidStatus4.10.0
temperatureStatusHwMonitorStatus详情参考temperatureStatus4.10.0

cpuStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

memoryStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

diskStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

nicStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

gpuStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

powerSupplyStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

fanStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

raidStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

temperatureStatus

名字类型描述起始版本
NormalHwMonitorStatus正常4.10.0
ErrorHwMonitorStatus异常4.10.0
UnknownHwMonitorStatus未知4.10.0

clusters

名字类型描述起始版本
nameString资源名称0.6
uuidString资源的UUID,唯一标示该资源0.6
descriptionString资源的详细描述0.6
stateString集群状态0.6
hypervisorTypeString虚拟机管理程序类型0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
zoneUuidString数据中心UUID0.6
typeString保留域0.6

SDK示例

Java SDK

GetVmStartingCandidateClustersHostsAction action = new GetVmStartingCandidateClustersHostsAction();
action.uuid = "b2789350a2f438ab9190bd18b7773527";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmStartingCandidateClustersHostsAction.Result res = action.call();

Python SDK

action = GetVmStartingCandidateClustersHostsAction()
action.uuid = "b2789350a2f438ab9190bd18b7773527"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()