CreateBareMetal2Instance

POST/zstack/v1/baremetal2/bm-instances

Operation ID

CreateBareMetal2Instance

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

application/json

Body Fields

params
ObjectRequired
Request body parameter object.
- name
  StringRequired
  The bare metal instance name.
- description
  String
  Optional. The detailed description of the bare metal instance.
- zoneUuid
  String
  Optional. The zone UUID.
- clusterUuid
  String
  Optional. The cluster UUID.
- gatewayUuid
  String
  Optional. The gateway UUID.
- chassisUuid
  String
  Optional. The bare metal chassis UUID.
- chassisOfferingUuid
  String
  Optional. The chassis offering UUID.
- imageUuid
  String
  Optional. The image UUID.
- primaryStorageUuidForRootVolume
  String
  Optional. The UUID of the primary storage where the root volume resides.
- primaryStorageUuidForDataVolume
  String
  Optional. The UUID of the primary storage where data volumes resides.
- dataDiskOfferingUuids
  List
  Optional. The data volume offering UUID.
- rootVolumeSystemTags
  List
  Optional. The root volume offering UUID.
- dataVolumeSystemTags
  List
  Optional. The system tags of data volumes.
- gatewayAllocatorStrategy
  String
  Optional. The gateway allocation policy.
- resourceUuid
  String
  Optional. The bare metal instance UUID.
- tagUuids
  List
  Optional. The tag UUIDs.
- chassisDiskUuid
  String
  Optional, The UUID of the local disk.
- l3NetworkUuids
  List
  The L3 network UUID list.
- defaultL3NetworkUuid
  String
  Optional. The UUID of the default L3 network.
- vmNicParams
  String
  Optional.The information of the vmNic
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

Responses

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.
inventory
BareMetal2InstanceInventoryRequired
See inventory.
- chassisUuid
  StringRequired
  The UUID of the bare metal chassis.
- lastChassisUuid
  StringRequired
  The UUID of the bare metal chassis where the instance last resides.
- gatewayUuid
  StringRequired
  The gateway UUID.
- lastGatewayUuid
  StringRequired
  The UUID of the last gateway.
- chassisOfferingUuid
  StringRequired
  The chassis offering UUID.
- gatewayAllocatorStrategy
  StringRequired
  The gateway allocation policy.
- status
  StringRequired
  The connection status of the bare metal instance.
- uuid
  StringRequired
  The UUID of the bare metal instance.
- name
  StringRequired
  The bare metal instance name.
- description
  StringRequired
  The detailed description of the bare metal instance.
- zoneUuid
  StringRequired
  The zone UUID.
- clusterUuid
  StringRequired
  The cluster UUID.
- imageUuid
  StringRequired
  The image UUID.
- rootVolumeUuid
  StringRequired
  The root volume UUID
- platform
  StringRequired
  The platform type.
- defaultL3NetworkUuid
  StringRequired
  The UUID of the default L3 network.
- type
  StringRequired
  The type of the bare metal instance.
- hypervisorType
  StringRequired
  The virtualization type.
- memorySize
  LongRequired
  The memory size.
- cpuNum
  IntegerRequired
  The number of CPU cores.
- cpuSpeed
  LongRequired
  The processing speed of the CPU.
- createDate
  TimestampRequired
  The time when the bare metal instance was created.
- lastOpDate
  TimestampRequired
  The time when the bare metal instance was last modified.
- state
  StringRequired
  The state of the bare metal instance.
- provisionNic
  BareMetal2InstanceProvisionNicInventoryRequired
  See provisionNic.
  uuid
  StringRequired
  The UUID of the NIC that is in the deployment network.
  networkUuid
  StringRequired
  The deployment network UUID.
  mac
  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.
- vmNics
  ListRequired
  See vmNics.
  uuid
  StringRequired
  The UUID of the NIC of the bare metal instance.
  vmInstanceUuid
  StringRequired
  The UUID of the VM instance.
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  ip
  StringRequired
  The IP address of the NIC.
  mac
  StringRequired
  The MAC address of the NIC.
  hypervisorType
  StringRequired
  The virtualization type.
  netmask
  StringRequired
  The netmask of the NIC.
  gateway
  StringRequired
  The gateway IP address.
  metaData
  StringRequired
  The metadata.
  ipVersion
  IntegerRequired
  The version of the IP address.
  deviceId
  IntegerRequired
  The device ID.
  type
  StringRequired
  The NIC type.
  createDate
  TimestampRequired
  The time when the NIC was created.
  lastOpDate
  TimestampRequired
  The time when the NIC was last modified.
  usedIps
  ListRequired
  See usedIps.
  uuid
  StringRequired
  The UUID of the IP address.
  ipRangeUuid
  StringRequired
  The IP range UUID.
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  ipVersion
  IntegerRequired
  The IP version.
  ip
  StringRequired
  The IP address.
  netmask
  StringRequired
  The netmask of the IP address.
  gateway
  StringRequired
  The gateway IP address.
  usedFor
  StringRequired
  The intended use.
  ipInLong
  longRequired
  The IP address represented as a long integer.
  vmNicUuid
  StringRequired
  The NIC UUID.
  createDate
  TimestampRequired
  The time when the IP address was created.
  lastOpDate
  TimestampRequired
  The time when the IP address was last modified.
- allVolumes
  ListRequired
  See allVolumes.
  uuid
  StringRequired
  The volume UUID.
  name
  StringRequired
  The volume name.
  description
  StringRequired
  The detailed description of the volume.
  primaryStorageUuid
  StringRequired
  The primary storage UUID.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  diskOfferingUuid
  StringRequired
  The volume offering UUID.
  rootImageUuid
  StringRequired
  The root image UUID.
  installPath
  StringRequired
  The installation path of the volume in the primary storage.
  type
  StringRequired
  The type of the volume.
  format
  StringRequired
  The format of the volume.
  size
  LongRequired
  The size of the volume.
  actualSize
  LongRequired
  The actual storage space that the volume takes up.
  deviceId
  IntegerRequired
  The device ID.
  state
  StringRequired
  The state of the volume.
  status
  StringRequired
  The status of the volume.
  createDate
  TimestampRequired
  The time when the volume was created.
  lastOpDate
  TimestampRequired
  The time when the volume was last modified.
  isShareable
  BooleanRequired
  Indicates whether the volume is shareable.
  volumeQos
  StringRequired
  The QoS of the volume, for example, 1048576.

Request Example

curl -X POST '{host}/zstack/v1/baremetal2/bm-instances' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -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}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ],
    "chassisDiskUuid": "{chassisDiskUuid}",
    "l3NetworkUuids": [
      "{l3NetworkUuids}"
    ],
    "defaultL3NetworkUuid": "{defaultL3NetworkUuid}",
    "vmNicParams": "{vmNicParams}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "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": 8589934592,
    "cpuNum": 8,
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running"
  }
}

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-09-23
AddedRequest body fields defaultL3NetworkUuid, l3NetworkUuids, vmNicParams
View API

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations