Get Cluster Status

Get Cluster Status

Get the status of a cluster.

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

cluster_status

Returns cluster_status of type(s) application/json 
{
    "endpoints": {
        "hostname": "string",
        "private_vip": "string",
        "public_vip": "string"
    },
    "ha_enabled": false,
    "ip_access_enabled": false,
    "nodes": [
        {
            "ip": "string",
            "name": "string",
            "role": "string",
            "status": "string"
        }
    ],
    "services": [
        {
            "desired": 0,
            "group": "string",
            "name": "string",
            "ready": 0
        }
    ],
    "status": "string"
}
object
endpoints
Required

An Endpoint for control plane

boolean
ha_enabled
Required

The HA enabled flag.

boolean
ip_access_enabled
Required

The ip access enabled flag.

array of object
nodes
Required

The nodes of cluster.

array of object
services
Required

The services of cluster.

string
status
Required

The status of the cluster.


401
Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/status
On This Page
Status Operations
GET
Get Cluster Status