com.cloudera.api.v1
Interface ClustersResource

All Known Subinterfaces:

ClustersResourceV10, ClustersResourceV11, ClustersResourceV12, ClustersResourceV13, ClustersResourceV14, ClustersResourceV15, ClustersResourceV16, ClustersResourceV17, ClustersResourceV18, ClustersResourceV2, ClustersResourceV3, ClustersResourceV4, ClustersResourceV5, ClustersResourceV6, ClustersResourceV7, ClustersResourceV8, ClustersResourceV9

public interface ClustersResource

Method Summary

ApiClusterList	createClusters(ApiClusterList clusters) Creates a collection of clusters.
ApiCluster	deleteCluster(String clusterName) Deletes a cluster.
ServicesResource	getServicesResource(String clusterName)
ApiCommandList	listActiveCommands(String clusterName, DataView dataView) List active cluster commands.
ApiCluster	readCluster(String clusterName) Reads information about a cluster.
ApiClusterList	readClusters(DataView dataView) Lists all known clusters.
ApiCommand	restartCommand(String clusterName) Restart all services in the cluster.
ApiCommand	startCommand(String clusterName) Start all services in the cluster.
ApiCommand	stopCommand(String clusterName) Stop all services in the cluster.
ApiCommand	upgradeServicesCommand(String clusterName) Deprecated. This endpoint should not used in Cloudera Manager 5 or later. Use the upgradeCdh endpoint on the cluster instead.

Method Detail

createClusters

@Path(value="/")
ApiClusterList createClusters(ApiClusterList clusters)

Creates a collection of clusters.

Parameters:

clusters - List of clusters to created.

Returns:

List of created clusters.

deleteCluster

@Path(value="/{clusterName}")
ApiCluster deleteCluster(String clusterName)

Deletes a cluster.

Parameters:

clusterName - Name of cluster to delete.

Returns:

Details of deleted cluster.

readClusters

@Path(value="/")
ApiClusterList readClusters(DataView dataView)

Lists all known clusters.

Returns:

List of known clusters.

readCluster

@Path(value="/{clusterName}")
ApiCluster readCluster(String clusterName)

Reads information about a cluster.

Parameters:

clusterName - Name of cluster to look up.

Returns:

Details of requested cluster.

getServicesResource

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

Returns:

The services resource handler.

listActiveCommands

@Path(value="/{clusterName}/commands")
ApiCommandList listActiveCommands(String clusterName,
                                       DataView dataView)

List active cluster commands.

Parameters:

clusterName - The name of the cluster.

dataView - The view of the data to materialize, either "summary" or "full".

Returns:

A list of active cluster commands.

upgradeServicesCommand

@Deprecated
@Path(value="/{clusterName}/commands/upgradeServices")
ApiCommand upgradeServicesCommand(String clusterName)

Deprecated. This endpoint should not used in Cloudera Manager 5 or later. Use the upgradeCdh endpoint on the cluster instead.

Upgrades the services in the cluster to the CDH5 version.

This command requires that the CDH packages in the hosts used by the cluster be upgraded to CDH5 before this command is issued. Once issued, this command will stop all running services before proceeding.

If parcels are used instead of CDH system packages then the following steps need to happen in order:

1. Stop all services manually
2. Activate parcel
3. Run this upgrade command

The command will upgrade the services and their configuration to the version available in the CDH5 distribution.

Parameters:

clusterName - The name of the cluster.

Returns:

Information about the submitted command.

startCommand

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

Start all services in the cluster.

Services are started in the appropriate order given their dependencies.

Parameters:

clusterName - The name of the cluster.

Returns:

Information about the submitted command.

stopCommand

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

Stop all services in the cluster.

Services are stopped in the appropriate order given their dependencies.

Parameters:

clusterName - The name of the cluster.

Returns:

Information about the submitted command.

restartCommand

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

Restart all services in the cluster.

Services are restarted in the appropriate order given their dependencies.

Parameters:

clusterName - The name of the cluster.

Returns:

Information about the submitted command.