跳转到主要内容
API Explorer|API Explorer
容器管理/容器管理相关接口
GETContainer Management APIs起始版本 5.3.6同步需要认证

查询原生容器主机

查询原生容器主机

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • qString

    查询条件。

响应状态

200 OK

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

  • successboolean必填

    查询接口调用是否成功

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • endpointUuidString必填

      容器管理端点UUID

    • zoneUuidString必填

      区域UUID

    • nameString必填

      资源名称

    • uuidString必填

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

    • clusterUuidString必填

      集群UUID

    • descriptionString必填

      资源的详细描述

    • managementIpString必填

      管理IP

    • hypervisorTypeString必填

      hypervisor类型

    • stateString必填

      启用状态

    • statusString必填

      连接状态

    • totalCpuCapacityLong必填

      总CPU容量

    • availableCpuCapacityLong必填

      可用的CPU容量

    • cpuSocketsInteger必填

      CPU插槽数量

    • totalMemoryCapacityLong必填

      总内存容量

    • availableMemoryCapacityLong必填

      可用的内存容量

    • cpuNumInteger必填

      CPU数量

    • ipmiAddressString必填

      IPMI地址

    • ipmiUsernameString必填

      IPMI用户名

    • ipmiPortInteger必填

      IPMI端口

    • ipmiPowerStatusString必填

      IPMI电源状态

    • architectureString必填

      架构

    • 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/container/native/host

/zstack/v1/container/native/host

操作 ID

QueryNativeHost

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/container/native/host?q=<q>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "zoneUuid": "5abd68b3e648472f8cf8c77795186990", "name": "example", "uuid": "1758fe38a8cd4887ab445ff46aaf432f", "clusterUuid": "e2ecc4b7bc9342e3a7522b8fed4db0f7", "managementIp": "127.0.0.1", "hypervisorType": "KVM", "cpuSockets": 2 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史