Skip to main content
ZStack
Resource Center/Elastic Bare Metal Management(Plus)

QueryBareMetal2Gateway

QueryBareMetal2Gateway

GET/zstack/v1/baremetal2/gateways
GET/zstack/v1/baremetal2/gateways/{uuid}

Operation ID

QueryBareMetal2Gateway

Since

4.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • q
    String

    Query conditions.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • inventories
    ListRequired

    See inventory.

    • attachedClusterUuids
      ListRequired

      The attached cluster UUIDs.

    • username
      StringRequired

      The username of the gateway.

    • sshPort
      IntegerRequired

      The SSH port.

    • zoneUuid
      StringRequired

      The zone UUID.

    • name
      StringRequired

      The name of the gateway.

    • uuid
      StringRequired

      The UUID of the gateway.

    • clusterUuid
      StringRequired

      The cluster UUID.

    • description
      StringRequired

      The detailed description of the gateway.

    • managementIp
      StringRequired

      The IP address of the management node.

    • hypervisorType
      StringRequired

      The virtualization type.

    • state
      StringRequired

      The state of the gateway.

    • status
      StringRequired

      The connection status of the gateway.

    • totalCpuCapacity
      LongRequired

      The total processing capacity of CPU.

    • availableCpuCapacity
      LongRequired

      The available processing capacity of CPU.

    • cpuSockets
      IntegerRequired

      The CPU sockets.

    • totalMemoryCapacity
      LongRequired

      The total memory size.

    • availableMemoryCapacity
      LongRequired

      The available memory size.

    • cpuNum
      IntegerRequired

      The number of CPU cores.

    • createDate
      TimestampRequired

      The time when the gateway was created.

    • lastOpDate
      TimestampRequired

      The time when the was gateway last modified.

    • provisionNic
      BareMetal2GatewayProvisionNicInventoryRequired

      See provisionNic.

      • uuid
        StringRequired

        The NIC UUID.

      • networkUuid
        StringRequired

        The deployment network UUID.

      • interfaceName
        StringRequired

        The name of the NIC.

      • ip
        StringRequired

        The IP address of the NIC.

      • netmask
        StringRequired

        The netmask of the NIC.

      • gateway
        StringRequired

        The gateway IP address.

      • metadata
        StringRequired

        The metadata.

      • createDate
        TimestampRequired

        The time when the NIC was created.

      • lastOpDate
        TimestampRequired

        The time when the NIC was last modified.