InspectBareMetal2ChassisByInstance

API Request

URLs

PUT zstack/v1/baremetal2/bm-instances/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "inspectBareMetal2ChassisByInstance": {},
  "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 '{"inspectBareMetal2ChassisByInstance":{}}' http://localhost:8080/zstack/v1/baremetal2/bm-instances/d40144a84b1633e8b2aacd333a7105d3/actions

Request Parameters

Name	Type	Location	Description	Starting Version
uuid	String	url	The resource UUID.	5.2.0
systemTags	List	body	Optional. The system tags.	5.2.0
userTags	List	body	Optional. The user tags.	5.2.0

API Response

Sample Response

{
  "inventory": {
    "uuid": "33ce10962f314b71be5b846cd7230af7",
    "name": "BM_CHASSIS",
    "description": "This is a bare metal chassis.",
    "zoneUuid": "d07b6968028a49e199373c51af1aca23",
    "clusterUuid": "3cb1198f2d964626ba1309a43d854610",
    "chassisOfferingUuid": "6f0ee825fd9a441885eebd70f0f9171c",
    "type": "IPMI",
    "state": "Enabled",
    "status": "Available",
    "powerStatus": "POWER_ON",
    "provisionType": "Remote",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}

Name	Type	Description	Starting Version
success	boolean		5.2.0
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error	5.2.0
inventory	BareMetal2ChassisInventory	See inventory	5.2.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.	5.2.0
description	String	The brief description of the error.	5.2.0
details	String	The details about the error.	5.2.0
elaboration	String	The reserved field. Default value: null.	5.2.0
opaque	LinkedHashMap	The reserved field. Default value: null.	5.2.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.	5.2.0

#inventory

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	5.2.0
name	String	The resource name.	5.2.0
description	String	Optional. The detailed description of the resource.	5.2.0
zoneUuid	String	The zone UUID.	5.2.0
clusterUuid	String	The cluster UUID.	5.2.0
chassisOfferingUuid	String	The elastic baremetal offering UUID.	5.2.0
type	String	The type.	5.2.0
state	String	The state.	5.2.0
status	String	The distribution status.	5.2.0
powerStatus	String	The power status.	5.2.0
createDate	Timestamp	The creation time.	5.2.0
lastOpDate	Timestamp	The last operation time.	5.2.0
chassisNics	List	See chassisNics	5.2.0
chassisDisks	List	See chassisDisks	5.2.0
chassisOffering	BareMetal2ChassisOfferingInventory	See chassisOffering	5.2.0

#chassisNics

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	5.2.0
chassisUuid	String	The baremetal node UUID.	5.2.0
mac	String	The NIC MAC address.	5.2.0
speed	String	The NIC speed.	5.2.0
isProvisionNic	Boolean	Whether the NIC is a provision NIC or not.	5.2.0
createDate	Timestamp	The creation time.	5.2.0
lastOpDate	Timestamp	The last operation time.	5.2.0

#chassisDisks

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	5.2.0
chassisUuid	String	The baremetal node UUID.	5.2.0
diskSize	Long	The disk size (Unit: byte).	5.2.0
type	String	The disk type.	5.2.0
createDate	Timestamp	The creation time.	5.2.0
lastOpDate	Timestamp	The last operation time.	5.2.0

#chassisOffering

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	5.2.0
name	String	The resource name.	5.2.0
description	String	The detailed description if the resource.	5.2.0
architecture	String	The CPU architecture.	5.2.0
cpuModelName	String	The CPU model.	5.2.0
cpuNum	Integer	The CPU cores.	5.2.0
memorySize	Long	The memory size.	5.2.0
bootMode	String	The status.	5.2.0
state	String	The state.	5.2.0
createDate	Timestamp	The creation time.	5.2.0
lastOpDate	Timestamp	The last operation time.	5.2.0

SDK Sample

Java SDK

InspectBareMetal2ChassisByInstanceAction action = new InspectBareMetal2ChassisByInstanceAction();
action.uuid = "d40144a84b1633e8b2aacd333a7105d3";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
InspectBareMetal2ChassisByInstanceAction.Result res = action.call();

Python SDK

InspectBareMetal2ChassisByInstanceAction action = InspectBareMetal2ChassisByInstanceAction()
action.uuid = "d40144a84b1633e8b2aacd333a7105d3"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
InspectBareMetal2ChassisByInstanceAction.Result res = action.call()