Get Baremetal Controller Status

Get Baremetal Controller Status
Get baremetal controller instance status

Retrieve the status of a baremetal controller instance.

Request
URI
GET
https://{api_host}/baremetal/controllers/{controller-id}/status
COPY
Path Parameters
string
controller-id
Required

Baremetal controller ID.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BaremetalControllerStatusResponse of type(s) application/json 
{
    "display_name": "string",
    "site_ids": [
        "string"
    ],
    "overall_status": "string",
    "last_reported": 0,
    "component_status": [
        {
            "component_name": "string",
            "status": "string",
            "message": "string"
        }
    ]
}
string
display_name
Optional

Baremetal server display name.

array of string
site_ids
Optional

Baremetal server siteIds.

string
overall_status
Optional

The baremetal controller status.

Possible values are : HEALTHY, DEGRADED, FAILED, UNKNOWN,
integer As int64 As int64
last_reported
Optional

Timestamp in milliseconds since epoch.

array of object
component_status
Optional

Controller component statuses.


default

Error response on API failure.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/baremetal/controllers/{controller-id}/status
On This Page
Baremetal Security Operations
GET
Get Baremetal Controller List
GET
Get Baremetal Controller Status
GET
Get Baremetal Server Status
GET
Get Baremetal Server List
POST
Perform Baremetal Servers Action
GET
Get Baremetal Server
DELETE
Uninstall Baremetal Server
GET
Get Baremetal Server Installer Bundle
GET
Get Registration Token
DELETE
Delete Registration Token
GET
Get Registration Token Status
GET
Get Registration Token Statuses
POST
Create Registration Token
GET
Get Registration Tokens
GET
Get Baremetal Services Status
GET
Get Baremetal Server Summary
POST
Query Baremetal Server Details
GET
Get Baremetal Task Status