Edit a Cluster

PUT /api/v2.2/clusters/<cluster ID> or <cluster label>

Use this API to edit a cluster through the cluster API version 2.2.

Note

For parameters associated with resizing a cluster, see Resize a Cluster.

Required Role

The following roles can make this API call:

A user who is part of the system-admin group.
A user invoking this API must be part of a group associated with a role that allows editing a cluster. See Managing Groups and Managing Roles for more information.

Parameters

Parameters describes the list of parameters of a cluster on AWS. You can change the name of the cluster.

Note

You can push the number of nodes into a running cluster as described in Resize a Cluster through API. You can also push the number of nodes through UI as described in How to Push Configuration Changes to a Cluster.

network_config

Note

The instance_tenancy parameter is configurable while editing a cluster and not while creating a cluster.

Parameter	Description
instance_tenancy	QDS provides instance tenancy at the cluster level and only in a VPC. The choice for tenancies are: `default` or `dedicated`. The `dedicated instance_tenancy` would mean the instances launched do not share physical hardware with any other instances outside of the respective AWS account.

Sample API Request

Here is a sample API request to edit a cluster with 123 as its cluster ID.

curl -X PUT -H "X-AUTH-TOKEN:$X_AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json"
-d
'{
"cluster_info": {
    "instance_tenancy":"default",
    "label":"cluster-production",
    "min_nodes": 2,
    "max_nodes": 8
   }
}' \
https://api.qubole.com/api/v2.2/clusters/123

Note

The above sample 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.