com.cloudera.api.v17
Interface ServicesResourceV17

All Superinterfaces:
ServicesResource, ServicesResourceV10, ServicesResourceV11, ServicesResourceV13, ServicesResourceV14, ServicesResourceV15, ServicesResourceV16, ServicesResourceV2, ServicesResourceV3, ServicesResourceV4, ServicesResourceV6, ServicesResourceV7, ServicesResourceV8
All Known Subinterfaces:
ServicesResourceV18

public interface ServicesResourceV17
extends ServicesResourceV16


Method Summary
 ApiCommand hiveValidateMetastoreSchemaCommand(String serviceName)
          Validate the Hive Metastore Schema.
 ApiCommand offlineCommand(String serviceName, ApiRoleNameList roleNames, Long timeout)
          Offline roles of a service.
 
Methods inherited from interface com.cloudera.api.v15.ServicesResourceV15
recommissionWithStartCommand
 
Methods inherited from interface com.cloudera.api.v14.ServicesResourceV14
getNameservicesResource, getWatchedDirResource, oozieDumpDatabaseCommand, oozieLoadDatabaseCommand
 
Methods inherited from interface com.cloudera.api.v13.ServicesResourceV13
createYarnCmContainerUsageInputDirCommand, getReplicationsResource
 
Methods inherited from interface com.cloudera.api.v11.ServicesResourceV11
getRolesResource, readService
 
Methods inherited from interface com.cloudera.api.v10.ServicesResourceV10
getRoleCommandsResource, hueDumpDbCommand, hueLoadDbCommand, hueSyncDbCommand, oozieCreateEmbeddedDatabaseCommand, sqoopCreateDatabaseTablesCommand
 
Methods inherited from interface com.cloudera.api.v8.ServicesResourceV8
collectYarnApplicationDiagnostics, disableLlamaHaCommand, disableLlamaRmCommand, enableLlamaHaCommand, enableLlamaRmCommand, hdfsFinalizeRollingUpgrade, sentryUpgradeDatabaseTablesCommand, yarnFormatStateStore
 
Methods inherited from interface com.cloudera.api.v7.ServicesResourceV7
firstRun, sentryCreateDatabaseCommand, sentryCreateDatabaseTablesCommand
 
Methods inherited from interface com.cloudera.api.v6.ServicesResourceV6
createImpalaUserDirCommand, createYarnJobHistoryDirCommand, createYarnNodeManagerRemoteAppLogDirCommand, disableOozieHaCommand, disableRmHaCommand, enableOozieHaCommand, enableRmHaCommand, getImpalaQueriesResource, getSnapshotsResource, getYarnApplicationsResource, hbaseUpgradeCommand, hdfsDisableNnHaCommand, hdfsEnableNnHaCommand, hdfsUpgradeMetadataCommand, hiveUpgradeMetastoreCommand, impalaCreateCatalogDatabaseCommand, impalaCreateCatalogDatabaseTablesCommand, importMrConfigsIntoYarn, listServiceCommands, oozieUpgradeDbCommand, serviceCommandByName, sqoopUpgradeDbCommand, switchToMr2
 
Methods inherited from interface com.cloudera.api.v4.ServicesResourceV4
createHiveUserDirCommand, createSolrHdfsHomeDirCommand, createSqoopUserDirCommand, disableJtHaCommand, enableJtHaCommand, getHdfsUsageReport, getMrUsageReport, hiveCreateMetastoreDatabaseCommand, hiveUpdateMetastoreNamenodesCommand, initSolrCommand
 
Methods inherited from interface com.cloudera.api.v3.ServicesResourceV3
createHiveWarehouseCommand, getRoleConfigGroupsResource, hdfsRollEditsCommand, hiveCreateMetastoreDatabaseTablesCommand, installOozieShareLib, rollingRestart, updateService
 
Methods inherited from interface com.cloudera.api.v2.ServicesResourceV2
createOozieDb, enterMaintenanceMode, exitMaintenanceMode, getClientConfig, hdfsCreateTmpDir, recommissionCommand
 
Methods inherited from interface com.cloudera.api.v1.ServicesResource
createBeeswaxWarehouseCommand, createHBaseRootCommand, createServices, decommissionCommand, deleteService, deployClientConfigCommand, getActivitiesResource, getMetrics, hdfsDisableAutoFailoverCommand, hdfsDisableHaCommand, hdfsEnableAutoFailoverCommand, hdfsEnableHaCommand, hdfsFailoverCommand, listActiveCommands, listRoleTypes, readService, readServiceConfig, readServices, restartCommand, startCommand, stopCommand, updateServiceConfig, zooKeeperCleanupCommand, zooKeeperInitCommand
 

Method Detail

offlineCommand

@Path(value="/{serviceName}/commands/offline")
ApiCommand offlineCommand(String serviceName,
                               ApiRoleNameList roleNames,
                               Long timeout)
Offline roles of a service.

Currently the offline operation is only supported by HDFS.

For HDFS, the offline operation will put DataNodes into HDFS IN MAINTENANCE state which prevents unnecessary re-replication which could occur if decommissioned.

The timeout parameter is used to specify a timeout for offline. For HDFS, when the timeout expires, the DataNode will automatically transition out of HDFS IN MAINTENANCE state, back to HDFS IN SERVICE state.

Parameters:
serviceName - The service name.
roleNames - List of role names to offline.
timeout - Offline timeout in seconds. Offlined roles will automatically transition from offline state to normal state after timeout. Specify as null to get the default timeout (4 hours).
Returns:
Information about the submitted command.

hiveValidateMetastoreSchemaCommand

@Path(value="/{serviceName}/commands/hiveValidateMetastoreSchema")
ApiCommand hiveValidateMetastoreSchemaCommand(String serviceName)
Validate the Hive Metastore Schema.

This command checks the Hive metastore schema for any errors and corruptions. This command is to be run on two instances:

  • After the Hive Metastore database tables are created.
  • Both before and after upgrading the Hive metastore database schema./li> *

    Available since API v17.

    Parameters:
    serviceName - Name of the Hive service on which to run the command.
    Returns:
    Information about the submitted command.


  • Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.