Skip to main content
API Explorer|API Explorer
Resource Center/Elastic Bare Metal Management(Plus)
GETElastic Bare Metal Management(Plus)Since 4.0.0SynchronousAuth Required

QueryBareMetal2Instance

QueryBareMetal2Instance

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • 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

    • chassisUuidStringRequired

      The UUID of the bare metal chassis.

    • lastChassisUuidStringRequired

      The UUID of the bare metal chassis where the instance last resides.

    • gatewayUuidStringRequired

      The gateway UUID.

    • lastGatewayUuidStringRequired

      The UUID of the last gateway.

    • chassisOfferingUuidStringRequired

      The chassis offering UUID.

    • gatewayAllocatorStrategyStringRequired

      The gateway allocation policy.

    • statusStringRequired

      The connection status of the elastic baremetal instance.

    • uuidStringRequired

      The UUID of the elastic baremetal instance.

    • nameStringRequired

      The elastic baremetal instance name.

    • descriptionStringRequired

      The detailed description of the elastic baremetal instance.

    • zoneUuidStringRequired

      The zone UUID.

    • clusterUuidStringRequired

      The cluster UUID.

    • imageUuidStringRequired

      The image UUID.

    • rootVolumeUuidStringRequired

      The root volume UUID

    • platformStringRequired

      The platform type.

    • defaultL3NetworkUuidStringRequired

      The UUID of the default L3 network.

    • typeStringRequired

      The type of the elastic baremetal instance.

    • hypervisorTypeStringRequired

      The virtualization type.

    • memorySizeLongRequired

      The memory size.

    • cpuNumIntegerRequired

      The number of CPU cores.

    • cpuSpeedLongRequired

      The processing speed of the CPU.

    • createDateTimestampRequired

      The time when the elastic baremetal instance was created.

    • lastOpDateTimestampRequired

      The time when the elastic baremetal instance was last modified.

    • stateStringRequired

      The state of the elastic baremetal instance.

    • provisionNicBareMetal2InstanceProvisionNicInventoryRequired

      See provisionNic

      • uuidStringRequired

        The UUID of the NIC that connects to the deployment network.

      • networkUuidStringRequired

        The deployment network UUID.

      • interfaceNameStringRequired

        The name of the NIC.

      • ipStringRequired

        The IP address of the NIC.

      • netmaskStringRequired

        The netmask of the NIC.

      • gatewayStringRequired

        The gateway IP address.

      • metadataStringRequired

        附加元数据。

      • createDateTimestampRequired

        The time when the NIC was created.

      • lastOpDateTimestampRequired

        The time when the NIC was last modified.

    • vmNicsListRequired

      See vmNics

      • uuidStringRequired

        The UUID of the NIC of the elastic baremetal instance.

      • vmInstanceUuidStringRequired

        The UUID of the elastic baremetal instance.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ipStringRequired

        The IP address of the NIC.

      • macStringRequired

        The MAC address of the NIC.

      • hypervisorTypeStringRequired

        The virtualization type.

      • netmaskStringRequired

        The netmask of the NIC.

      • gatewayStringRequired

        The gateway IP address.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        The version of the IP address.

      • deviceIdIntegerRequired

        The device ID.

      • typeStringRequired

        The NIC type.

      • createDateTimestampRequired

        The time when the NIC was created.

      • lastOpDateTimestampRequired

        The time when the NIC was last modified.

      • usedIpsListRequired

        See usedIps

        • uuidStringRequired

          The UUID of the IP address.

        • ipRangeUuidStringRequired

          The IP range UUID.

        • l3NetworkUuidStringRequired

          The L3 network UUID.

        • ipVersionIntegerRequired

          The IP version.

        • ipStringRequired

          The IP address.

        • netmaskStringRequired

          The netmask of the IP address.

        • gatewayStringRequired

          The gateway IP address.

        • usedForStringRequired

          已使用用于。

        • ipInLonglongRequired

          No description provided.

        • vmNicUuidStringRequired

          The NIC UUID.

        • createDateTimestampRequired

          The time when the IP address was created.

        • lastOpDateTimestampRequired

          The time when the IP address was last modified.

    • allVolumesListRequired

      See allVolumes

      • uuidStringRequired

        The volume UUID.

      • nameStringRequired

        The volume name.

      • descriptionStringRequired

        The detailed description of the volume.

      • primaryStorageUuidStringRequired

        The primary storage UUID.

      • vmInstanceUuidStringRequired

        The elastic baremetal instance UUID.

      • diskOfferingUuidStringRequired

        The volume offering UUID.

      • rootImageUuidStringRequired

        The root image UUID.

      • installPathStringRequired

        The installation path of the volume in the primary storage.

      • typeStringRequired

        The type of the volume.

      • formatStringRequired

        The format of the volume.

      • sizeLongRequired

        The size of the volume.

      • actualSizeLongRequired

        The actual storage space that the volume takes up.

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        The state of the volume.

      • statusStringRequired

        The status of the volume.

      • createDateTimestampRequired

        The time when the volume was created.

      • lastOpDateTimestampRequired

        The time when the volume was last modified.

      • isShareableBooleanRequired

        Indicates whether the volume is shareable.

      • volumeQosStringRequired

        The QoS of the volume, for example, 1048576.

Endpoint

GET/zstack/v1/baremetal2/bm-instances

/zstack/v1/baremetal2/bm-instances

Operation ID

QueryBareMetal2Instance

Permalink

Request Example

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

Response Example

200
{ "inventories": [ { "chassisUuid": "463018b125d742e8acb3d6a5412eb674", "lastChassisUuid": "5facc3e540e3464daef9dc123aae9f2b", "gatewayUuid": "2cdd33f2d2f14b599965b2b351c77c10", "lastGatewayUuid": "e96b15632b2d4975ae4252a8d33b3904", "chassisOfferingUuid": "db5d18b6551e4af492bda6cef97045e3", "status": "Connected", "uuid": "f6898853cff24b2a85c388f4c676d1a7", "name": "BM-1", "description": "This is a BareMetal2 Instance.", "zoneUuid": "8f741ad043a54c98a9729c3871cfc985", "clusterUuid": "1bf322359f0e41668a67e119fc2184d1", "imageUuid": "17ddfe24cce247f2a27a13ad78b1536a", "rootVolumeUuid": "e1551175153c4d4f89edfccf85e15fbe", "platform": "Linux", "type": "baremetal2", "memorySize": 8.589934592E9, "cpuNum": 8.0, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Running" } ] }

Change History

This API has no change history records yet.

View all change history