Get Services Status

Monitor individual platform service health and resource utilization

Retrieve service health and resource metrics per category.

Service Categories: MESSAGING (message broker), ANALYTICS (analysis), DATA_STORAGE (storage), CONFIGURATION_DATABASE, PLATFORM_SERVICES, METRICS, BARE_METAL_SECURITY, AI_ASSISTANT_PLATFORM, AI_ASSISTANT_THREAT_DEFENSE

Per-service metrics:

health: UP, PARTIALLY_UP, DOWN (60-second cache)
cpu: [1min, 5min, 15min] averages in cores
memory, storage: current usage in GB
allocated_*: total available resources

Messaging service metrics:

byte_in_rate, byte_out_rate: Bytes/sec
request_rate: Messages produced/sec

Request

URI

GET

https://{api_host}/ssp/cluster/monitor/services/status

COPY

Authentication

This operation uses the following authentication methods.

Responses

200

Successfully retrieved services status

Returns ServiceStatusList of type(s) application/json

{
    "data": [
        {
            "service_name": "MESSAGING"
        }
    ],
    "messaging_service": {
        "byte_in_rate": 3.5,
        "byte_out_rate": 24.8,
        "request_rate": 12.5
    }
}

array of data

data

Required

List of status objects for each service category.

object

messaging_service

Required

Detailed messaging service transmission rate metrics. Provides real-time information about message broker performance.

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

An error occurred while retrieving services status.

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}/ssp/cluster/monitor/services/status

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Cluster Monitor Operations