StartBareMetal2Instance

API Request

URLs
PUT zstack/v1/baremetal2/bm-instances/{uuid}/action
Headers
Authorization: OAuth the-session-uuid
Body
{
  "startBareMetal2Instance": {
    "clusterUuid": "5308459a6fbd35dba89956f7025e34e3",
    "gatewayUuid": "921a40b2a91a3189b70fb41e5c838d80",
    "chassisUuid": "93db25cb3e763d57b2ebfce5129434c1"
  },
  "systemTags": [],
  "userTags": []
}
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"startBareMetal2Instance":{"clusterUuid":"5308459a6fbd35dba89956f7025e34e3","gatewayUuid":"921a40b2a91a3189b70fb41e5c838d80","chassisUuid":"93db25cb3e763d57b2ebfce5129434c1"}}' http://localhost:8080/zstack/v1/baremetal2/bm-instances/62f5e08b9d5f3c729a63d558d3eb023a/action
Request Parameters
Name Type Location Description Valid Value Starting Version
uuid String url The bare metal instance UUID. 4.0.0
clusterUuid String body(contained in the startBareMetal2Instance structure) Optional. The cluster UUID. 4.0.0
gatewayUuid String body(contained in the startBareMetal2Instance structure) Optional. The gateway UUID. 4.0.0
chassisUuid String body(contained in the startBareMetal2Instance structure) Optional. The bare metal chassis UUID. 4.0.0
chassisOfferingUuid String body Optional. The bare metal chassis offering UUID. 4.0.0
systemTags List body Optional. The system tags. 4.0.0
userTags List body Optional. The user tags. 4.0.0

API Response

Sample Response
{
  "inventory": {
    "chassisUuid": "71589294e70d41408331e22b5dc61510",
    "lastChassisUuid": "aa3bd0a4fb3545d59df7febd62fcb22b",
    "gatewayUuid": "770bdbc4be1a4faf84756022fe434caf",
    "lastGatewayUuid": "b8ed1247500b405ead053babc8f1a5db",
    "chassisOfferingUuid": "bbeb7fddcf9943749ca1a96cddf16f15",
    "status": "Connected",
    "uuid": "a60f5e148e2f4a2ba06afc2785bf8a42",
    "name": "BM-1",
    "description": "This is a BareMetal2 Instance.",
    "zoneUuid": "c40cb9c7e86a45c892b190cc9a356e7a",
    "clusterUuid": "8251f2399e7c4075969686fe22367b81",
    "imageUuid": "3e2afb0cc212448bb8f72ddaaa90d080",
    "rootVolumeUuid": "8dc4889a2d6748a5aaa17ebaa2cbca28",
    "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"
  }
}
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error 4.0.0
inventory BareMetal2InstanceInventory See inventory 4.0.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 4.0.0
description String The brief description of the error. 4.0.0
details String The details about the error. 4.0.0
elaboration String The reserved field. Default value: null. 4.0.0
opaque LinkedHashMap The reserved field. Default value: null. 4.0.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 4.0.0
#inventory
Name Type Description Starting Version
chassisUuid String The UUID of the bare metal chassis. 4.0.0
lastChassisUuid String The UUID of the bare metal chassis where the instance last resides. 4.0.0
gatewayUuid String The gateway UUID. 4.0.0
lastGatewayUuid String The UUID of the last gateway. 4.0.0
chassisOfferingUuid String The chassis offering UUID. 4.0.0
gatewayAllocatorStrategy String The gateway allocation policy. 4.0.0
status String The connection status of the bare metal instance. 4.0.0
uuid String The UUID of the bare metal instance. 4.0.0
name String The bare metal instance name. 4.0.0
description String The detailed description of the bare metal instance. 4.0.0
zoneUuid String The zone UUID. 4.0.0
clusterUuid String The cluster UUID. 4.0.0
imageUuid String The image UUID. 4.0.0
rootVolumeUuid String The root volume UUID 4.0.0
platform String The platform type. 4.0.0
defaultL3NetworkUuid String The UUID of the default L3 network. 4.0.0
type String The type of the bare metal instance. 4.0.0
hypervisorType String The virtualization type. 4.0.0
memorySize Long The memory size. 4.0.0
cpuNum Integer The number of CPU cores. 4.0.0
cpuSpeed Long The processing speed of the CPU. 4.0.0
createDate Timestamp The time when the bare metal instance was created. 4.0.0
lastOpDate Timestamp The time when the bare metal instance was last modified. 4.0.0
state String The state of the bare metal instance. 4.0.0
provisionNic BareMetal2InstanceProvisionNicInventory See provisionNic 4.0.0
vmNics List See vmNics 4.0.0
allVolumes List See allVolumes 4.0.0
#provisionNic
Name Type Description Starting Version
uuid String The UUID of the NIC that connects to the deployment network. 4.0.0
networkUuid String The deployment network UUID. 4.0.0
mac String The name of the NIC. 4.0.0
ip String The IP address of the NIC. 4.0.0
netmask String The netmask of the NIC. 4.0.0
gateway String The gateway IP address. 4.0.0
metadata String 4.0.0
createDate Timestamp The time when the NIC was created. 4.0.0
lastOpDate Timestamp The time when the NIC was last modified. 4.0.0
#vmNics
Name Type Description Starting Version
uuid String The UUID of the NIC of the bare metal instance. 4.0.0
vmInstanceUuid String The UUID of the bare metal instance. 4.0.0
l3NetworkUuid String The L3 network UUID. 4.0.0
ip String The IP address of the NIC. 4.0.0
mac String The MAC address of the NIC. 4.0.0
hypervisorType String The virtualization type. 4.0.0
netmask String The netmask of the NIC. 4.0.0
gateway String The gateway IP address. 4.0.0
metaData String 4.0.0
ipVersion Integer The version of the IP address. 4.0.0
deviceId Integer The device ID. 4.0.0
type String The NIC type. 4.0.0
createDate Timestamp The time when the NIC was created. 4.0.0
lastOpDate Timestamp The time when the NIC was last modified. 4.0.0
usedIps List See usedIps 4.0.0
#usedIps
Name Type Description Starting Version
uuid String The UUID of the IP address. 4.0.0
ipRangeUuid String The IP range UUID. 4.0.0
l3NetworkUuid String The L3 network UUID. 4.0.0
ipVersion Integer The IP version. 4.0.0
ip String The IP address. 4.0.0
netmask String The netmask of the IP address. 4.0.0
gateway String The gateway IP address. 4.0.0
usedFor String 4.0.0
ipInLong long 4.0.0
vmNicUuid String The NIC UUID. 4.0.0
createDate Timestamp The time when the IP address was created. 4.0.0
lastOpDate Timestamp The time when the IP address was last modified. 4.0.0
#allVolumes
Name Type Description Starting Version
uuid String The volume UUID. 4.0.0
name String The volume name. 4.0.0
description String The detailed description of the volume. 4.0.0
primaryStorageUuid String The primary storage UUID. 4.0.0
vmInstanceUuid String The bare metal instance UUID. 4.0.0
diskOfferingUuid String The volume offering UUID. 4.0.0
rootImageUuid String The root image UUID. 4.0.0
installPath String The installation path of the volume in the primary storage. 4.0.0
type String The type of the volume. 4.0.0
format String The format of the volume. 4.0.0
size Long The size of the volume. 4.0.0
actualSize Long The actual storage space that the volume takes up. 4.0.0
deviceId Integer 4.0.0
state String The state of the volume. 4.0.0
status String The status of the volume. 4.0.0
createDate Timestamp The time when the volume was created. 4.0.0
lastOpDate Timestamp The time when the volume was last modified. 4.0.0
isShareable Boolean Indicates whether the volume is shareable. 4.0.0
volumeQos String The QoS of the volume, for example, 1048576. 4.0.0

SDK Sample

Java SDK
StartBareMetal2InstanceAction action = new StartBareMetal2InstanceAction();
action.uuid = "62f5e08b9d5f3c729a63d558d3eb023a";
action.clusterUuid = "5308459a6fbd35dba89956f7025e34e3";
action.gatewayUuid = "921a40b2a91a3189b70fb41e5c838d80";
action.chassisUuid = "93db25cb3e763d57b2ebfce5129434c1";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
StartBareMetal2InstanceAction.Result res = action.call();
Python SDK
StartBareMetal2InstanceAction action = StartBareMetal2InstanceAction()
action.uuid = "62f5e08b9d5f3c729a63d558d3eb023a"
action.clusterUuid = "5308459a6fbd35dba89956f7025e34e3"
action.gatewayUuid = "921a40b2a91a3189b70fb41e5c838d80"
action.chassisUuid = "93db25cb3e763d57b2ebfce5129434c1"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
StartBareMetal2InstanceAction.Result res = action.call()