Check Cluster Status on Google Cloud Platform

GET /api/v2/clusters/<cluster ID/cluster-label>

Use this API to get the current state of a cluster.

Required Role

The following users can make this API call:

  • Users who belong to the system-admin or system-user group.
  • Users who belong to a group associated with a role that allows viewing a cluster configuration. See Managing Groups and Managing Roles for more information.

Request API Syntax

Here is the API request syntax to know the current status of a cluster.

curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://gcp.qubole.com/api/v2/clusters/<cluster ID/cluster label>/state"
Copy to clipboard

Sample API Request

Here is the sample API request to know the current status of a cluster that has 250 as its ID.

curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://gcp.qubole.com/api/v2/clusters/250/state"
Copy to clipboard