/clusters/{clusterName}

Mount Point: /api/v2/clusters/{clusterName}

The following operations are supported on this resource:

PUT

Update an existing cluster.

You may not change a cluster's CDH version using this API call. Use the "upgradeService" cluster command instead.

To rename the cluster, pass in a json structure that has the new cluster name.

Available since API v2.

Parameters

name description type default
clusterName The name of the cluster. path

Request Body

element: cluster

(no documentation provided)

Response Body

element: cluster

Details of the affected cluster.

DELETE

Deletes a cluster.

Parameters

name description type default
clusterName Name of cluster to delete. path

Response Body

element: cluster

Details of deleted cluster.

GET

Reads information about a cluster.

Parameters

name description type default
clusterName Name of cluster to look up. path

Response Body

element: cluster

Details of requested cluster.