com.cloudera.api.v1

Interface MgmtServiceResource

All Known Subinterfaces:

MgmtServiceResourceV2, MgmtServiceResourceV3, MgmtServiceResourceV6, MgmtServiceResourceV8

public interface MgmtServiceResource

Method Summary

Methods

Modifier and Type	Method and Description
MgmtRoleCommandsResource	getMgmtRoleCommandsResource() Returns the management role commands resource handler.
MgmtRolesResource	getRolesResource() Return the management roles resource handler.
ApiCommandList	listActiveCommands(DataView dataView) List active Cloudera Management Services commands.
ApiRoleTypeList	listRoleTypes() List the supported role types for the Cloudera Management Services.
ApiService	readService() Retrieve information about the Cloudera Management Services.
ApiServiceConfig	readServiceConfig(DataView dataView) Retrieve the configuration of the Cloudera Management Services.
ApiCommand	restartCommand() Restart the Cloudera Management Services.
ApiService	setupCMS(ApiService service) Setup the Cloudera Management Services.
ApiCommand	startCommand() Start the Cloudera Management Services.
ApiCommand	stopCommand() Stop the Cloudera Management Services.
ApiServiceConfig	updateServiceConfig(String message, ApiServiceConfig config) Update the Cloudera Management Services configuration.

Method Detail

readService

@Path(value="/")
ApiService readService()

Retrieve information about the Cloudera Management Services.

Returns:

Details about the management service.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

readServiceConfig

@Path(value="/config")
ApiServiceConfig readServiceConfig(DataView dataView)

Retrieve the configuration of the Cloudera Management Services.

Parameters:

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

Returns:

List with configured and available configuration options.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

updateServiceConfig

@Path(value="/config")
ApiServiceConfig updateServiceConfig(String message,
                                        ApiServiceConfig config)

Update the Cloudera Management Services configuration.

If a value is set in the given configuration, it will be added to the service's configuration, replacing any existing entries. If a value is unset (its value is null), the existing configuration for the attribute will be erased, if any.

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

Parameters:

message - Optional message describing the changes.

config - Configuration changes.

Returns:

The new service configuration.

Throws:

javax.ws.rs.ClientErrorException - if no service exists.

listRoleTypes

@Path(value="/roleTypes")
ApiRoleTypeList listRoleTypes()

List the supported role types for the Cloudera Management Services.

Returns:

List of role types the service supports.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

listActiveCommands

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

List active Cloudera Management Services commands.

Parameters:

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

Returns:

A list of active role commands.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

startCommand

@Path(value="/commands/start")
ApiCommand startCommand()

Start the Cloudera Management Services.

Returns:

A reference to the submitted command.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

stopCommand

@Path(value="/commands/stop")
ApiCommand stopCommand()

Stop the Cloudera Management Services.

Returns:

A reference to the submitted command.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

restartCommand

@Path(value="/commands/restart")
ApiCommand restartCommand()

Restart the Cloudera Management Services.

Returns:

A reference to the submitted command.

Throws:

javax.ws.rs.NotFoundException - if no service exists.

setupCMS

@Path(value="/")
ApiService setupCMS(ApiService service)

Setup the Cloudera Management Services.

Configure the CMS instance and create all the management roles. The provided configuration data can be used to set up host mappings for each role, and required configuration such as database connection information for specific roles.

Regardless of the list of roles provided in the input data, all management roles are created by this call. The input is used to override any default settings for the specific roles.

This method needs a valid CM license to be installed beforehand.

This method does not start any services or roles.

This method will fail if a CMS instance already exists.

Available role types:

• SERVICEMONITOR
• ACTIVITYMONITOR
• HOSTMONITOR
• REPORTSMANAGER
• EVENTSERVER
• ALERTPUBLISHER
• NAVIGATOR
• NAVIGATORMETASERVER

REPORTSMANAGER, NAVIGATOR and NAVIGATORMETASERVER are only available with Cloudera Manager Enterprise Edition.

Parameters:

service - Role configuration overrides.

Returns:

ApiService The CMS information.

getRolesResource

@Path(value="/roles")
MgmtRolesResource getRolesResource()

Return the management roles resource handler.

Returns:

The roles resource handler.

getMgmtRoleCommandsResource

@Path(value="/roleCommands")
MgmtRoleCommandsResource getMgmtRoleCommandsResource()

Returns the management role commands resource handler.

Returns:

The roles command handler.