GridGain Developers Hub

REST API

Control Center provides a REST API that gives you the ability to communicate with GridGain 9 clusters over HTTP and HTTPS protocols using the REST approach.

Get Cluster Health Reports

Authenticate with your Control Center credentials (email and password) and specify the connectionId in the request.

GET /rest/v1/clusters/{connectionId}/health
Connection id GridGain 9

The endpoint returns the cluster health report in JSON format.

Example request:

curl -v \
  -u "username@example.com:password" \
  "https://<control-center-url:port>/rest/v1/clusters/<connectionId>/health" \
  -H "Accept: application/json"

Example response:

{
  "status": "GOOD",
  "reports": [
    {
      "reportName": "OfflineCmgNodes",
      "description": null,
      "status": "GOOD"
    },
    {
      "reportName": "OfflineMgNodes",
      "description": null,
      "status": "GOOD"
    },
    {
      "reportName": "Alerts",
      "description": null,
      "status": "GOOD"
    },
    {
      "reportName": "PartitionLoss",
      "description": null,
      "status": "GOOD"
    }
  ]
}

You can also view a specific report by passing reportName property to the endpoint:

/rest/v1/clusters/{connectionId}/health/{reportName}

Example response:

{
   "reportName": "PartitionLoss",
   "description": null,
   "status": "GOOD"
}