Cluster API Cluster information

Cluster API documentation for Cluster information of its ID and connection status

ClusterInfo

GET /cluster/info

Get the Id and connection status of the cluster

Response JSON Object:
 
  • id (string) – The ID of the cluster
  • isConnected (boolean) – The connection status of the cluster
  • error (string) – An error if any.
  • errorTime (string) – When the error occured (as a RFC3339 timestamp). To be ignored if error is empty.
  • nextRetry (string) – When the next retry will happen (as a RFC3339 timestamp). To be ignored if error is empty.

Example response:

{
  "id": "mycluster",
  "isConnected": true,
  "error": ""
}