Skip to content

Cluster Health State

White Labeled partners and operators have access to check the cluster states anytime via Swagger-based APIs using various query parameters such as cluster type/status/id/name and organization name/id.

API DOCS

The health status of each cluster ranges from 0 to 3.

Health Status Description
0 Cluster is not provisioned
1 Cluster is healthy
2 Cluster is not healthy
3 Cluster is disconnected

Use the GET REST API under Partner Cluster to view the cluster details with health states

All Cluster States

To view the states of all the clusters, click Execute without providing any query parameters. Below is an example with the response of all the clusters' state

API DOCS

View by Cluster Type

Select any one cluster_type from the drop-down to view the clusters of a specific type (example: gke, imported, manual, etc.) and click Execute. The below example is an example of gke type

API DOCS

View by Cluster Status

Select any one cluster_status from the drop-down to view the clusters of a specific status (example: 0,1,2,3) and click Execute. The below response is an example of 1 status that shows only the healthy clusters

API DOCS

View by Organization Name

Enter the organization_name to view the cluster state of that specific organization and click Execute. The below response is an example of qc-test organization showing the cluster details of the specified org

API DOCS

View by Organization ID

Enter the organization_id to view the cluster state associated with that specific organization id and click Execute. The below response is an example of 7w2lnkp organization id showing the cluster details of the specified id

API DOCS

View by Cluster ID

Enter the cluster_id to view the cluster state associated with that specific cluster id and click Execute. The below response is an example of 1ky7gkz cluster id showing the cluster details of the specified id

API DOCS

View by Cluster Name

Enter the cluster_name to view the cluster state of a specific cluster and click Execute. The below response is an example of the test-100 cluster showing the cluster details of the specified id

API DOCS

Multiple Query Parameters

Users can try a combination of two or more query parameters to retrieve specific cluster information. For example, select cluster type aws-eks, health status 1, and enter the organization name rafay_qa. Click Execute

API DOCS

Below is an example of the generated response that contains the cluster details with the above-specified parameters

API DOCS