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

CreateBareMetal2Instance

CreateBareMetal2Instance

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      The bare metal instance name.

    • descriptionString

      Optional. The detailed description of the bare metal instance.

    • zoneUuidString

      Optional. The zone UUID.

    • clusterUuidString

      Optional. The cluster UUID.

    • gatewayUuidString

      Optional. The gateway UUID.

    • chassisUuidString

      Optional. The bare metal chassis UUID.

    • chassisOfferingUuidString

      Optional. The chassis offering UUID.

    • imageUuidString

      Optional. The image UUID.

    • primaryStorageUuidForRootVolumeString

      Optional. The UUID of the primary storage where the root volume resides.

    • primaryStorageUuidForDataVolumeString

      Optional. The UUID of the primary storage where data volumes resides.

    • dataDiskOfferingUuidsList

      Optional. The data volume offering UUID.

    • rootVolumeSystemTagsList

      Optional. The root volume offering UUID.

    • dataVolumeSystemTagsList

      Optional. The system tags of data volumes.

    • gatewayAllocatorStrategyString

      Optional. The gateway allocation policy.

    • chassisDiskUuidString

      Optional, The UUID of the local disk.

    • resourceUuidString

      Optional. The bare metal instance UUID.

    • tagUuidsList

      Optional. The tag UUIDs.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

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.

  • inventoryBareMetal2InstanceInventoryRequired

    See inventory.

    • 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 bare metal instance.

    • uuidStringRequired

      The UUID of the bare metal instance.

    • nameStringRequired

      The bare metal instance name.

    • descriptionStringRequired

      The detailed description of the bare metal 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 bare metal 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 bare metal instance was created.

    • lastOpDateTimestampRequired

      The time when the bare metal instance was last modified.

    • stateStringRequired

      The state of the bare metal instance.

    • provisionNicBareMetal2InstanceProvisionNicInventoryRequired

      See provisionNic.

      • uuidStringRequired

        The UUID of the NIC that is in the deployment network.

      • networkUuidStringRequired

        The deployment network UUID.

      • macStringRequired

        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 bare metal instance.

      • vmInstanceUuidStringRequired

        The UUID of the VM 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 VM 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

POST/zstack/v1/baremetal2/bm-instances

/zstack/v1/baremetal2/bm-instances

Operation ID

CreateBareMetal2Instance

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/baremetal2/bm-instances' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","zoneUuid":"<zoneUuid>","clusterUuid":"<clusterUuid>","gatewayUuid":"<gatewayUuid>","chassisUuid":"<chassisUuid>","chassisOfferingUuid":"<chassisOfferingUuid>","imageUuid":"<imageUuid>","primaryStorageUuidForRootVolume":"<primaryStorageUuidForRootVolume>","primaryStorageUuidForDataVolume":"<primaryStorageUuidForDataVolume>","dataDiskOfferingUuids":["<dataDiskOfferingUuids>"],"rootVolumeSystemTags":["<rootVolumeSystemTags>"],"dataVolumeSystemTags":["<dataVolumeSystemTags>"],"gatewayAllocatorStrategy":"<gatewayAllocatorStrategy>","chassisDiskUuid":"<chassisDiskUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "chassisUuid": "abdb84a7186446828d679ca390400804", "lastChassisUuid": "2e16e29ad4d94a348d3f633358792ebe", "gatewayUuid": "8a2a62c0d26f46af9b835515ca26cf79", "lastGatewayUuid": "bc627e89139043e292aea1d691740f58", "chassisOfferingUuid": "b943087d48644fe7a9165d447b1197e6", "status": "Connected", "provisionType": "Remote", "uuid": "870fde072c314db49fb6c91ca6f893f6", "name": "BM-1", "description": "This is a BareMetal2 Instance.", "zoneUuid": "66bbd29bcd8d4313816dc6ed26e86c97", "clusterUuid": "f3b09f2ac776470bb0710db497e13b6c", "imageUuid": "1d499497394e443ba4d5f502d42ffff1", "rootVolumeUuid": "f88731c18e58481e8d7c98158e8b2948", "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