QueryHost

API Request

URLs

GET zstack/v1/hosts
GET zstack/v1/hosts/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

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

Queryable Fields

Run the CLI command tool, enter QueryHost, and press Tab to view all queryable fields and resource names that support cross-table queries.

API Response

Response Example

{
  "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
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeded.	0.6
error	ErrorCode	Error code. If not null, the operation failed. If null, the operation succeeded. See error for details	0.6
inventories	List	See inventories for details	0.6

#error

Name	Type	Description	Starting Version
code	String	Error code number, globally unique identifier, e.g. SYS.1000, HOST.1001	0.6
description	String	Brief error description	0.6
details	String	Detailed error information	0.6
elaboration	String	Reserved field, defaults to null	0.6
opaque	LinkedHashMap	Reserved field, defaults to null	0.6
cause	ErrorCode	Root cause. The error that caused the current error. If there is no original error, this field is null	0.6

#inventories

Name	Type	Description	Starting Version
zoneUuid	String	Data Center UUID	0.6
name	String	Resource name	0.6
uuid	String	Resource UUID, uniquely identifies the resource	0.6
clusterUuid	String	Cluster UUID	0.6
description	String	Resource description	0.6
managementIp	String	The management IP.	0.6
hypervisorType	String	The hypervisor type.	0.6
state	String	Host state, including: Enabled Disabled PreMaintenance Maintenance	0.6
status	String	Connecting Connected Disconnected	0.6
totalCpuCapacity	Long	The total CPU capacity.	0.6
availableCpuCapacity	Long	The available CPU capacity.	0.6
cpuSockets	Integer	The CPU sockets.	0.6
totalMemoryCapacity	Long	The total memory capacity.	0.6
availableMemoryCapacity	Long	The available memory capacity.	0.6
cpuNum	Integer	Logical CPU count	0.6
ipmiAddress	String	IPMI address	0.6
ipmiUsername	String	IPMI username	0.6
ipmiPort	Integer	IPMI port	0.6
ipmiPowerStatus	String	IPMI power status	0.6
architecture	String	The architecture.	0.6
nqn	String	NVMe qualified name	4.10.6
hostname	String	Host name	4.10.20
createDate	Timestamp	Creation time	0.6
lastOpDate	Timestamp	Last modification time	0.6
cpuStatus	HwMonitorStatus	See cpuStatus	4.10.0
memoryStatus	HwMonitorStatus	See memoryStatus	4.10.0
diskStatus	HwMonitorStatus	See diskStatus	4.10.0
nicStatus	HwMonitorStatus	See nicStatus	4.10.0
gpuStatus	HwMonitorStatus	See gpuStatus	4.10.0
powerSupplyStatus	HwMonitorStatus	See powerSupplyStatus	4.10.0
fanStatus	HwMonitorStatus	See fanStatus	4.10.0
raidStatus	HwMonitorStatus	See raidStatus	4.10.0
temperatureStatus	HwMonitorStatus	See temperatureStatus	4.10.0

#cpuStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#memoryStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#diskStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#nicStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#gpuStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#powerSupplyStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#fanStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#raidStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

#temperatureStatus

Name	Type	Description	Starting Version
Normal	HwMonitorStatus	Normal	4.10.0
Error	HwMonitorStatus	Error	4.10.0
Unknown	HwMonitorStatus	Unknown	4.10.0

SDK Examples

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()

PreviousDeleteHost NextPowerOnHost