com.cloudera.api.v1

Interface ClouderaManagerResource

All Known Subinterfaces:

ClouderaManagerResourceV11, ClouderaManagerResourceV12, ClouderaManagerResourceV14, ClouderaManagerResourceV15, ClouderaManagerResourceV16, ClouderaManagerResourceV17, ClouderaManagerResourceV2, ClouderaManagerResourceV3, ClouderaManagerResourceV6, ClouderaManagerResourceV7, ClouderaManagerResourceV8

public interface ClouderaManagerResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	collectDiagnosticDataCommand(ApiCollectDiagnosticDataArguments args) Collect diagnostic data from hosts managed by Cloudera Manager.
ApiCommand	generateCredentialsCommand() Generate missing Kerberos credentials.
ApiConfigList	getConfig(DataView dataView) Retrieve the Cloudera Manager settings.
InputStream	getLog() Returns the entire contents of the Cloudera Manager log file
MgmtServiceResource	getMgmtServiceResource() Return the Cloudera Management Services resource.
ApiVersionInfo	getVersion() Provides version information of Cloudera Manager itself.
ApiCommand	inspectHostsCommand() Runs the host inspector on the configured hosts.
ApiCommandList	listActiveCommands(DataView dataView) List active global commands.
ApiLicense	readLicense() Retrieve information about the Cloudera Manager license.
ApiConfigList	updateConfig(ApiConfigList config) Update the Cloudera Manager settings.
ApiLicense	updateLicense(byte[] license) Updates the Cloudera Manager license.

Method Detail

getConfig

@Path(value="/config")
ApiConfigList getConfig(DataView dataView)

Retrieve the Cloudera Manager settings.

Parameters:

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

Returns:

The current Cloudera Manager settings.

updateConfig

@Path(value="/config")
ApiConfigList updateConfig(ApiConfigList config)

Update the Cloudera Manager settings.

If a value is set in the given configuration, it will be added to the manager's settings, replacing any existing entry. If a value is unset (its value is null), the existing the setting will be erased.

Settings that are not listed in the input will maintain their current values.

Parameters:

config - Settings to update.

Returns:

The updated configuration.

readLicense

@Path(value="/license")
ApiLicense readLicense()

Retrieve information about the Cloudera Manager license.

Returns:

The current license information.

updateLicense

@Path(value="/license")
ApiLicense updateLicense(byte[] license)

Updates the Cloudera Manager license.

After a new license is installed, the Cloudera Manager needs to be restarted for the changes to take effect.

The license file should be uploaded using a request with content type "multipart/form-data", instead of being encoded into a JSON representation.

Parameters:

license - The license file to install.

Returns:

The new license information.

listActiveCommands

@Path(value="/commands")
ApiCommandList listActiveCommands(DataView dataView)

List active global commands.

Parameters:

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

Returns:

A list of active global commands.

generateCredentialsCommand

@Path(value="/commands/generateCredentials")
ApiCommand generateCredentialsCommand()

Generate missing Kerberos credentials.

This command will affect all services that have been configured to use Kerberos, and haven't had their credentials generated yet.

Returns:

Information about the submitted command.

inspectHostsCommand

@Path(value="/commands/inspectHosts")
ApiCommand inspectHostsCommand()

Runs the host inspector on the configured hosts.

Returns:

Information about the submitted command.

getMgmtServiceResource

@Path(value="/service")
MgmtServiceResource getMgmtServiceResource()

Return the Cloudera Management Services resource.

Returns:

The Cloudera Management Services resource.

collectDiagnosticDataCommand

@Path(value="/commands/collectDiagnosticData")
ApiCommand collectDiagnosticDataCommand(ApiCollectDiagnosticDataArguments args)

Collect diagnostic data from hosts managed by Cloudera Manager.

After the command has completed, the ApiCommand will contain a resultDataUrl from where you can download the result.

Only available with Cloudera Manager Enterprise Edition.

Parameters:

args - The command arguments.

Returns:

Detailed command information.

getVersion

@Path(value="version")
ApiVersionInfo getVersion()

Provides version information of Cloudera Manager itself.

Returns:

Version information

getLog

@Path(value="/log")
InputStream getLog()

Returns the entire contents of the Cloudera Manager log file