/clusters/{clusterName}
Mount Point: /api/v6/clusters/{clusterName}
The following operations are supported on this resource:
PUT
Update an existing cluster.
To update the CDH version, provide the new value in the "fullVersion" property. Setting a correct version that matches the actual installed software will ensure the correct version-specific features, such as services, roles, commands, and configurations. This need not be manually set for clusters using parcels. In general this action is only necessary after the CDH packages have been manually updated. Note that a downgrade may be rejected if it would render existing services or roles unusable. For major upgrade, the "upgradeService" cluster command should be used instead.
To rename the cluster, provide the new name in the "displayName" property for API >= 6, or in the "name" property for API <=5.
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.