跳转到主要内容
API Explorer|API Explorer
计算管理/主机相关接口
GETHost Related Interfaces起始版本 0.6同步需要认证

查询主机

查询主机

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoriesList必填

    详情参考inventories

    • zoneUuidString必填

      数据中心UUID

    • nameString必填

      资源名称

    • uuidString必填

      资源的UUID，唯一标示该资源

    • clusterUuidString必填

      集群UUID

    • descriptionString必填

      资源的详细描述

    • managementIpString必填

      管理IP。

    • hypervisorTypeString必填

      暂无描述。

    • stateString必填

      主机状态，包括： Enabled Disabled PreMaintenance Maintenance

    • statusString必填

      状态信息。

    • totalCpuCapacityLong必填

      总CPU容量。

    • availableCpuCapacityLong必填

      可用CPU容量。

    • cpuSocketsInteger必填

      暂无描述。

    • totalMemoryCapacityLong必填

      总内存容量。

    • availableMemoryCapacityLong必填

      可用内存容量。

    • cpuNumInteger必填

      逻辑CPU数量

    • ipmiAddressString必填

      IPMI地址

    • ipmiUsernameString必填

      IPMI用户名

    • ipmiPortInteger必填

      IPMI端口

    • ipmiPowerStatusString必填

      IPMI电源状态

    • architectureString必填

      暂无描述。

    • nqnString必填

      NVMe 限定名称

    • hostnameString必填

      主机名

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • cpuStatusHwMonitorStatus必填

      详情参考cpuStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • memoryStatusHwMonitorStatus必填

      详情参考memoryStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • diskStatusHwMonitorStatus必填

      详情参考diskStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • nicStatusHwMonitorStatus必填

      详情参考nicStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • gpuStatusHwMonitorStatus必填

      详情参考gpuStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • powerSupplyStatusHwMonitorStatus必填

      详情参考powerSupplyStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • fanStatusHwMonitorStatus必填

      详情参考fanStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • raidStatusHwMonitorStatus必填

      详情参考raidStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • temperatureStatusHwMonitorStatus必填

      详情参考temperatureStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

请求地址

GET/zstack/v1/hosts

/zstack/v1/hosts

操作 ID

QueryHost

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/hosts' -H 'Authorization: OAuth {sessionUuid}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史