com.cloudera.api.v2

Interface ClustersResourceV2

All Superinterfaces:

ClustersResource

All Known Subinterfaces:

ClustersResourceV3, ClustersResourceV4, ClustersResourceV5, ClustersResourceV6, ClustersResourceV7, ClustersResourceV8

public interface ClustersResourceV2
extends ClustersResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	deployClientConfig(String clusterName) Deploy the cluster-wide client configuration.
ApiCommand	enterMaintenanceMode(String clusterName) Put the cluster into maintenance mode.
ApiCommand	exitMaintenanceMode(String clusterName) Take the cluster out of maintenance mode.
ServicesResourceV2	getServicesResource(String clusterName)
ApiCluster	updateCluster(String clusterName, ApiCluster cluster) Update an existing cluster.

Methods inherited from interface com.cloudera.api.v1.ClustersResource

createClusters, deleteCluster, listActiveCommands, readCluster, readClusters, restartCommand, startCommand, stopCommand, upgradeServicesCommand

Method Detail

getServicesResource

@Path(value="/{clusterName}/services")
ServicesResourceV2 getServicesResource(String clusterName)

Specified by:

getServicesResource in interface ClustersResource

Returns:

The services resource handler.

updateCluster

@Path(value="/{clusterName}")
ApiCluster updateCluster(String clusterName,
                            ApiCluster cluster)

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:

clusterName - The name of the cluster.

Returns:

Details of the affected cluster.

enterMaintenanceMode

@Path(value="/{clusterName}/commands/enterMaintenanceMode")
ApiCommand enterMaintenanceMode(String clusterName)

Put the cluster into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

Parameters:

clusterName - The name of the cluster

Returns:

Synchronous command result.

exitMaintenanceMode

@Path(value="/{clusterName}/commands/exitMaintenanceMode")
ApiCommand exitMaintenanceMode(String clusterName)

Take the cluster out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

Parameters:

clusterName - The name of the cluster

Returns:

Synchronous command result.

deployClientConfig

@Path(value="/{clusterName}/commands/deployClientConfig")
ApiCommand deployClientConfig(String clusterName)

Deploy the cluster-wide client configuration.

For each service in the cluster, deploy the service's client configuration to all the hosts that the service runs on.

Available since API v2.

Parameters:

clusterName - The name of the cluster

Returns:

Information about the submitted command.