Service State Legend

This page is part of MariaDB's Documentation.

The parent of this page is: Dashboards

Topics on this page:

Overview
Compatibility
Service States
SkySQL Monitoring
SkySQL Portal
SkySQL DBaaS API

Overview

MariaDB SkySQL performs health checks and provides information about the Service State:

In SkySQL Monitoring, the Service State is represented by an icon next to the service name
In the SkySQL Portal, the Service State is shown underneath the service name on the Services view and Service Details view
With the SkySQL DBaaS API, the Service State can be retrieved using multiple interfaces:
- With the skysqlcli command-line interface, the Service State can be retrieved using the get status command
- With a REST client, the Service State can be retrieved using a Read Status request
When the Service State is Healthy (via SkySQL Portal) or Running (via SkySQL DBaaS API), it is prepared to receive allowlisted client connections
When the Service State is Pending, it is still being created

Compatibility

Distributed Transactions
Multi-Node Analytics
Replicated Transactions
Single Node Analytics
Single Node Transactions

Service States

MariaDB SkySQL's Service States are listed in the following table:

Service State	Description
`Healthy`	The service is prepared to receive allowlisted client connections Shown in the SkySQL Portal `Running` is shown by the SkySQL DBaaS API instead
`Internal Error`	The service has encountered a fault while being launched or terminated Shown in the SkySQL Portal and SkySQL DBaaS API
`Pending`	The service is still being created Shown in the SkySQL Portal and SkySQL DBaaS API
`Running`	The service is prepared to receive allowlisted client connections Shown in the SkySQL DBaaS API `Healthy` is shown by the SkySQL Portal instead
`Starting`	The service is still being started Shown in the SkySQL Portal and SkySQL DBaaS API
`Stopped`	The service has successfully been stopped Shown in the SkySQL Portal and SkySQL DBaaS API
`Stopping`	The service is still being stopped Shown in the SkySQL Portal and SkySQL DBaaS API
`Unhealthy`	The service has encountered a service fault or is being restarted by Configuration Manager Shown in the SkySQL Portal and SkySQL DBaaS API
`Unknown`	The service is in an unknown state. Shown in the SkySQL Portal and SkySQL DBaaS API

SkySQL Monitoring

In SkySQL Monitoring, the Service State is represented by an icon next to the service name:

SkySQL Portal

In the SkySQL Portal, the Service State is shown in multiple locations.

The Service State is shown underneath the service name on the Services view:

The Service State is also shown underneath the service name on the Service Details view:

SkySQL DBaaS API

With the SkySQL DBaaS API, the Service State can be retrieved using multiple interfaces.

With the skysqlcli command-line interface, the Service State can be retrieved using the get status command and providing the service ID:

$ skysqlcli get status 'db00000001' \
   | jq .

{
  "status": "Running"
}

The skysqlcli command-line interface requires authentication with an API Key.

With a REST client, the Service State can be retrieved using a Read Status request by sending a GET request to the /services/SERVICE_ID/status/ endpoint:

$ curl --location \
   --header 'Authorization: Bearer SKYSQL_BEARER_TOKEN' \
   https://api.skysql.net/services/db00000001/status/ \
   | jq .

{
  "status": "Running"
}

The Authorization header must be in the format Authorization: Bearer SKYSQL_BEARER_TOKEN, where SKYSQL_BEARER_TOKEN is the bearer token.

No request body is required.