View the Cluster Instances Information
- GET /api/v1.3/clusters/<cluster_id> or <cluster_label>/instances
Use this API to view the cluster instances information of a given cluster. You can use the cluster’s ID or label to invoke this API. It is supported with QDS version R57 onwards.
Required Role
The following users can make this API call:
Users who belong to the system-user or system-admin group.
Users who belong to a group associated with a role that allows viewing all clusters. See Managing Groups and Managing Roles for more information.
Parameters
Note
Parameters marked in bold below are mandatory. Others are optional and have default values.
Parameter |
Description |
|---|---|
inst_id |
Use this parameter to see a specific cluster instance’s information by specifying its instance ID. |
page |
Use this parameter to specify the page number that contains the cluster instances’ history. Its default value is 1. |
per_page |
Use this parameter to specify the number of cluster instances to be retrieved per page. Its default
value is |
private_ip |
The private IP address of the worker node if you want to see the nodebootstrap logs. |
Examples
View the cluster instances information of a cluster with 569 as its ID
curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type:application/json" -H "Accept: application/json" \
https://api.qubole.com/api/v1.3/clusters/569/instances
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.
View the cluster instances from a specific page and limiting the number of instances per page
curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type:application/json" -H "Accept: application/json" \
https://api.qubole.com/api/v1.3/clusters/569/instances?page=4&per_page=3
View the information of a specific cluster instance by specifying its ID
curl -X GET -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type:application/json" -H "Accept: application/json" \
https://api.qubole.com/api/v1.3/clusters/569/instances?inst_id=8