Document navigation

CheckBareMetal2IpmiChassisConfigFile

API Request

URLs

POST zstack/v1/baremetal2/chassis/ipmi/from-file/check

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "chassisInfo": "FILE CONTENT ENCODE BY BASE64"
  },
  "systemTags": [],
  "userTags": []
}

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 POST -d '{"params":{"chassisInfo":"FILE CONTENT ENCODE BY BASE64"}}' http://localhost:8080/zstack/v1/baremetal2/chassis/ipmi/from-file/check

Request Parameters

Name Type Location Description Valid Value Starting Version
chassisInfo String body(contained in the params structure) The base64-encoded configuration file of bare metal chassis. 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

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

SDK Sample

Java SDK

CheckBareMetal2IpmiChassisConfigFileAction action = new CheckBareMetal2IpmiChassisConfigFileAction();
action.chassisInfo = "FILE CONTENT ENCODE BY BASE64";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CheckBareMetal2IpmiChassisConfigFileAction.Result res = action.call();

Python SDK

action = CheckBareMetal2IpmiChassisConfigFileAction()
action.chassisInfo = "FILE CONTENT ENCODE BY BASE64"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()