Get the power board info
1. API Description
This API is used to get the information of the power board connected with the chassis.
Request mode: POST [ip]/api/chassis/get-backplane
Administrator Rights | Logged-in |
---|---|
No | Yes |
2. Input Parameters
None
3. Output Parameters
Name | Type | Description |
---|---|---|
status | Int | Status code |
code | String | Status description |
device-name | String | The device name |
power-num | Int | The number of power modules |
state | Int | The current status of the power board 0: Communication failure 1: Communication successful 2: Firmware upgrade in progress |
power | Array of PowerData | The list of power modules |
PowerData
Name | Type | Description |
---|---|---|
id | Int | The ID of power module |
state | String | The status of power module, including ON, OFF, ERROR, No AC power and Power module disconnected |
4. Example
Getting the information of power board.
Input Example
None
Output Example
{
"device-name": "Modator 2U POWER BOARD",
"power-num": 2,
"state": 2,
"power": [
{
"id": 1,
"state": "OFF"
},
{
"id": 2,
"state": "OFF"
}
],
"status": 0,
"code": "Success"
}
{
"device-name": "Modator 2U POWER BOARD",
"power-num": 2,
"state": 0,
"status": 0,
"code": "Success"
}
5. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.