查询主机

GET/zstack/v1/hosts

GET/zstack/v1/hosts/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hosts?q=uuid=66547f0fc9fd45d98f6b8482488f2993

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/hosts/bb582f21cfad4f61a2ab1ec062131b4a

可查询字段

运行CLI命令行工具，输入QueryHost并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "zoneUuid": "37649b12f572303a883c19c4c7af0856",
      "name": "example",
      "uuid": "f7bae73b9874344b8766dfcdda48ad6e",
      "clusterUuid": "d59c027b81fe3bbc9d78ef45f574febb",
      "description": "example",
      "managementIp": "192.168.0.1",
      "hypervisorType": "KVM",
      "state": "Enabled",
      "status": "Connected",
      "totalCpuCapacity": 4,
      "availableCpuCapacity": 2,
      "cpuSockets": 4,
      "totalMemoryCapacity": 4294967296,
      "availableMemoryCapacity": 4294967296,
      "cpuNum": 4
    }
  ]
}

名字	类型	描述	起始版本
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	主机状态，包括：- Enabled Disabled PreMaintenance Maintenance	0.6
status	String	Connecting Connected Disconnected	0.6
totalCpuCapacity	Long		0.6
availableCpuCapacity	Long		0.6
cpuSockets	Integer		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

QueryHostAction action = new QueryHostAction();
action.conditions = asList("uuid=2b8e587e99093c46b27e774dfe93024f");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHostAction.Result res = action.call();

Python SDK

action = QueryHostAction()
action.conditions = ["uuid=ff6d905e75d63e18ab0a9fc2ac14951c"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()