Check Cluster Status

GET /api/v2.2/clusters/<<Cluster ID>/<Cluster Label>>/state

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

Required Role

The following roles can make this API call:

  • A user who is part of the system-user/system-admin group.

  • A user invoking this API must be part of a group associated with a role that allows viewing a cluster configuration. See Managing Groups and Managing Roles for more information.

Various Types of Cluster States

States

Description

UP

This state indicates that the cluster is active.

DOWN

This state indicates that the cluster is inactive/not running.

PENDING

This state indicates that the cluster is in the process of booting up.

TERMINATING

This state indicates that the cluster is in the process of shutting down.

Examples

Get the state of a running cluster

curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
https://api.qubole.com/api/v2.2/clusters/1710/state

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Get the state of a terminated cluster

curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json"
https://api.qubole.com/api/v2.2/clusters/1711/state

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.