Get Baremetal Services Status

Get Baremetal Services Status
Get statuses of bmc and bmo instances

Get status for all baremetal services - Controllers and Orchestrator.

Request
URI
GET
https://{api_host}/baremetal/services/status
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BaremetalServiceStatus of type(s) application/json 
{
    "orchestrator": "string",
    "controllers": [
        {
            "_create_user": "string",
            "_create_time": 0,
            "_last_modified_user": "string",
            "_last_modified_time": 0,
            "_revision": 0,
            "_resource_type": "string",
            "_system_owned": false,
            "id": "string",
            "display_name": "string",
            "description": "string",
            "site_ids": [
                "string"
            ],
            "ip_address": "string",
            "status": "string",
            "server_count": 0,
            "components": [
                {
                    "component_name": "string",
                    "status": "string",
                    "message": "string"
                }
            ]
        }
    ]
}
string
orchestrator
Optional

The baremetal controller status.

Enumeration: HEALTHY, DEGRADED, FAILED, UNKNOWN
array of controllers
controllers
Optional

List of baremetal controllers.


400

Bad Request

Returns BadRequest 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.


401

Unauthorized

Returns Unauthorized 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.


403

Forbidden

Returns Forbidden 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.


412

Precondition Failed

Returns PreconditionFailed 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.


428

Precondition Required

Returns PreconditionRequired 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.


429

Too Many Requests

Returns TooManyRequests 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.


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/services/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 Baremetal Server Windows Agent 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