虚拟机相关接口
获取可热迁移的主机列表
获取一个虚拟机可以热迁移的主机列表。
Headers
Authorization: OAuth the-session-uuidCurl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth cf673ad3be454b49b24c4405f67531f0" \
-X GET http://localhost:8080/zstack/v1/vm-instances/98995eddf4854acc8b80da119fee81d5/migration-target-hosts参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| vmInstanceUuid | String | url | 虚拟机UUID | 0.6 | |
| systemTags (可选) | List | query | 系统标签 | 0.6 | |
| userTags (可选) | List | query | 用户标签 | 0.6 |
API返回
返回示例
{
"inventories": [
{
"zoneUuid": "fe27a95b6eda315280dc875b014ab086",
"name": "example",
"uuid": "a4660c07fd0636e3949fd76a09cbe2a8",
"clusterUuid": "0f29f323e58c3cdbb41bbc83344e9c82",
"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"
}
]
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 0.6 |
| inventories | List | 详情参考inventories | 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 |
inventories
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| 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 | 物理CPU插槽数量 | 0.6 |
| totalMemoryCapacity | Long | 0.6 | |
| availableMemoryCapacity | Long | 0.6 | |
| cpuNum | Integer | 逻辑CPU数量 | 0.6 |
| ipmiAddress | String | IPMI地址 | 0.6 |
| ipmiUsername | String | IPMI用户名 | 0.6 |
| ipmiPort | Integer | IPMI端口 | 0.6 |
| ipmiPowerStatus | String | IPMI电源状态 | 0.6 |
| architecture | String | 0.6 | |
| nqn | String | NVMe 限定名称 | 4.10.6 |
| hostname | String | 主机名 | 4.10.20 |
| createDate | Timestamp | 创建时间 | 0.6 |
| lastOpDate | Timestamp | 最后一次修改时间 | 0.6 |
| cpuStatus | HwMonitorStatus | 详情参考cpuStatus | 4.10.0 |
| memoryStatus | HwMonitorStatus | 详情参考memoryStatus | 4.10.0 |
| diskStatus | HwMonitorStatus | 详情参考diskStatus | 4.10.0 |
| nicStatus | HwMonitorStatus | 详情参考nicStatus | 4.10.0 |
| gpuStatus | HwMonitorStatus | 详情参考gpuStatus | 4.10.0 |
| powerSupplyStatus | HwMonitorStatus | 详情参考powerSupplyStatus | 4.10.0 |
| fanStatus | HwMonitorStatus | 详情参考fanStatus | 4.10.0 |
| raidStatus | HwMonitorStatus | 详情参考raidStatus | 4.10.0 |
| temperatureStatus | HwMonitorStatus | 详情参考temperatureStatus | 4.10.0 |
cpuStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
memoryStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
diskStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
nicStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
gpuStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
powerSupplyStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
fanStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
raidStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
temperatureStatus
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| Normal | HwMonitorStatus | 正常 | 4.10.0 |
| Error | HwMonitorStatus | 异常 | 4.10.0 |
| Unknown | HwMonitorStatus | 未知 | 4.10.0 |
SDK示例
Java SDK
GetVmMigrationCandidateHostsAction action = new GetVmMigrationCandidateHostsAction();
action.vmInstanceUuid = "d7b73f96a95c3f6faa6f58360c980dcb";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmMigrationCandidateHostsAction.Result res = action.call();Python SDK
action = GetVmMigrationCandidateHostsAction()
action.vmInstanceUuid = "d7b73f96a95c3f6faa6f58360c980dcb"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()