Skip to main content
API Explorer|API Explorer
Container Management/Container Management APIs
GETContainer Management APIsSince 5.3.6SynchronousAuth Required

QueryNativeHost

QueryNativeHost

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • qString

    Query conditions.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    Whether the query API call succeeds.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    See inventories.

    • endpointUuidStringRequired

      The container management endpoint UUID.

    • zoneUuidStringRequired

      The zone UUID.

    • nameStringRequired

      The resource name.

    • uuidStringRequired

      The resource UUID.

    • clusterUuidStringRequired

      The cluster UUID.

    • descriptionStringRequired

      The detailed description of the resource.

    • managementIpStringRequired

      The management IP address.

    • hypervisorTypeStringRequired

      The hypervisor type.

    • stateStringRequired

      The enablement state.

    • statusStringRequired

      The connection status.

    • totalCpuCapacityLongRequired

      The total CPU capacity.

    • availableCpuCapacityLongRequired

      The available CPU capacity.

    • cpuSocketsIntegerRequired

      The number of CPU sockets.

    • totalMemoryCapacityLongRequired

      The total memory capacity.

    • availableMemoryCapacityLongRequired

      The available memory capacity.

    • cpuNumIntegerRequired

      The number of CPUs.

    • ipmiAddressStringRequired

      The IPMI address.

    • ipmiUsernameStringRequired

      The IPMI username.

    • ipmiPortIntegerRequired

      The IPMI port.

    • ipmiPowerStatusStringRequired

      The IPMI power status.

    • architectureStringRequired

      The architecture.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • cpuStatusHwMonitorStatusRequired

      See cpuStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • memoryStatusHwMonitorStatusRequired

      See memoryStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • diskStatusHwMonitorStatusRequired

      See diskStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • nicStatusHwMonitorStatusRequired

      See nicStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • gpuStatusHwMonitorStatusRequired

      See gpuStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • powerSupplyStatusHwMonitorStatusRequired

      See powerSupplyStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • fanStatusHwMonitorStatusRequired

      See fanStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • raidStatusHwMonitorStatusRequired

      See raidStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

    • temperatureStatusHwMonitorStatusRequired

      See temperatureStatus.

      • NormalHwMonitorStatusRequired

        The normal status.

      • ErrorHwMonitorStatusRequired

        The error status.

      • UnknownHwMonitorStatusRequired

        The unknown status.

Endpoint

GET/zstack/v1/container/native/host

/zstack/v1/container/native/host

Operation ID

QueryNativeHost

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history