Resources

You may also enjoy the Swagger UI provided for this API.

name path methods description
ActivitiesResource
  • /clusters/{clusterName}/services/{serviceName}/activities
  • /clusters/{clusterName}/services/{serviceName}/activities/{activityId}
  • /clusters/{clusterName}/services/{serviceName}/activities/{activityId}/children
  • /clusters/{clusterName}/services/{serviceName}/activities/{activityId}/metrics
  • /clusters/{clusterName}/services/{serviceName}/activities/{activityId}/similar
  • GET
  • GET
  • GET
  • GET
  • GET
 
AllHostsResource
  • /cm/allHosts/config
  • GET, PUT
 
AuditsResource
  • /audits
  • /audits/stream
  • GET
  • GET
 
AuthRoleMetadatasResource
  • /authRoleMetadatas
  • GET
Returns a list of the auth roles' metadata for the built-in roles.
AuthRolesResource
  • /authRoles
  • /authRoles/metadata
  • /authRoles/{uuid}
  • GET, POST
  • GET
  • DELETE, GET, PUT
 
AuthServiceResource
  • /cm/authService
  • /cm/authService/autoAssignRoles
  • /cm/authService/autoConfigure
  • /cm/authService/commands
  • /cm/authService/config
  • /cm/authService/roleTypes
  • /cm/authService/commands/enterMaintenanceMode
  • /cm/authService/commands/exitMaintenanceMode
  • /cm/authService/commands/restart
  • /cm/authService/commands/start
  • /cm/authService/commands/stop
  • DELETE, GET, PUT
  • PUT
  • PUT
  • GET
  • GET, PUT
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST

The Authentication Service is used to manage Single Sign On capabilities.

This service is not yet available for general use.

The API to control the Authentication Service is basically the same as the API for the MGMT service. Both are not associated with a cluster and represent CM-managed resources.
AuthServiceRoleCommandsResource
  • /cm/authService/roleCommands/restart
  • /cm/authService/roleCommands/start
  • /cm/authService/roleCommands/stop
  • POST
  • POST
  • POST
 
AuthServiceRoleConfigGroupsResource
  • /cm/authService/roleConfigGroups
  • /cm/authService/roleConfigGroups/{roleConfigGroupName}
  • /cm/authService/roleConfigGroups/{roleConfigGroupName}/config
  • /cm/authService/roleConfigGroups/{roleConfigGroupName}/roles
  • GET
  • GET, PUT
  • GET, PUT
  • GET
 
AuthServiceRolesResource
  • /cm/authService/roles
  • /cm/authService/roles/{roleName}
  • /cm/authService/roles/{roleName}/commands
  • /cm/authService/roles/{roleName}/config
  • /cm/authService/roles/{roleName}/commands/enterMaintenanceMode
  • /cm/authService/roles/{roleName}/commands/exitMaintenanceMode
  • /cm/authService/roles/{roleName}/logs/full
  • /cm/authService/roles/{roleName}/logs/stacks
  • /cm/authService/roles/{roleName}/logs/stacksBundle
  • /cm/authService/roles/{roleName}/logs/stderr
  • /cm/authService/roles/{roleName}/logs/stdout
  • GET, POST
  • DELETE, GET
  • GET
  • GET, PUT
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
 
BatchResource
  • /batch
  • POST
Executes a batch of API requests in one database transaction. If any request fails, execution halts and the transaction is rolled back.
CdpResource
  • /cdp/createEnvironment
  • /cdp/remoteContext
  • /cdp/remoteContext/byCluster/{clusterName}
  • /cdp/remoteContext/byContext/{dataContextName}
  • POST
  • POST
  • GET
  • GET
Root resource for the CDPD Api calls.
CertManagerResource
  • /certs/generateCertificate
  • /certs/truststore
  • /certs/truststorePassword
  • POST
  • GET
  • GET
 
ClouderaManagerResource
  • /cm/clusterSupportTokens
  • /cm/commands
  • /cm/config
  • /cm/configPolicies
  • /cm/deleteInstances
  • /cm/deployment
  • /cm/importClusterTemplate
  • /cm/instances
  • /cm/kerberosInfo
  • /cm/kerberosPrincipals
  • /cm/krb5conf
  • /cm/license
  • /cm/licensedFeatureUsage
  • /cm/log
  • /cm/retrieveKeytab
  • /cm/scmDbInfo
  • /cm/shutdownReadiness
  • /cm/version
  • /cm/commands/addCustomCerts
  • /cm/commands/clustersPerfInspector
  • /cm/commands/collectDiagnosticData
  • /cm/commands/deleteCredentials
  • /cm/commands/disableCsp
  • /cm/commands/enableCsp
  • /cm/commands/generateCmca
  • /cm/commands/generateCredentials
  • /cm/commands/generateCredentialsAdhoc
  • /cm/commands/hostInstall
  • /cm/commands/hostsDecommission
  • /cm/commands/hostsOfflineOrDecommission
  • /cm/commands/hostsPerfInspector
  • /cm/commands/hostsRecommission
  • /cm/commands/hostsRecommissionAndExitMaintenanceMode
  • /cm/commands/hostsRecommissionWithStart
  • /cm/commands/hostsStartRoles
  • /cm/commands/hostsStopRoles
  • /cm/commands/importAdminCredentials
  • /cm/commands/importKerberosPrincipal
  • /cm/commands/inspectHosts
  • /cm/commands/migrateCmcaToDb
  • /cm/commands/refreshParcelRepos
  • /cm/commands/rotateCspKeys
  • /cm/commands/testExternalAuthentication
  • /cm/commands/updateCspType
  • /cm/commands/updateGlobalTruststore
  • /cm/instances/{cmServerId}
  • /cm/trial/begin
  • /cm/trial/end
  • GET
  • GET
  • GET, PUT
  • DELETE, GET, POST
  • POST
  • GET, PUT
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET, POST
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
 
ClustersResource
  • /clusters
  • /clusters/{clusterName}
  • /clusters/{clusterName}/autoAssignRoles
  • /clusters/{clusterName}/autoConfigure
  • /clusters/{clusterName}/clientConfig
  • /clusters/{clusterName}/clusterSupportToken
  • /clusters/{clusterName}/commands
  • /clusters/{clusterName}/dfsServices
  • /clusters/{clusterName}/export
  • /clusters/{clusterName}/getOzoneBucketInfo
  • /clusters/{clusterName}/getOzoneS3GatewayInfo
  • /clusters/{clusterName}/hosts
  • /clusters/{clusterName}/isTlsEnabled
  • /clusters/{clusterName}/kerberosInfo
  • /clusters/{clusterName}/serviceTypes
  • /clusters/{clusterName}/tags
  • /clusters/{clusterName}/upgradeDomains
  • /clusters/{clusterName}/utilization
  • /clusters/{clusterName}/commands/configureAutoTlsServices
  • /clusters/{clusterName}/commands/configureForKerberos
  • /clusters/{clusterName}/commands/deleteCredentials
  • /clusters/{clusterName}/commands/deployClientConfig
  • /clusters/{clusterName}/commands/deployClientConfigsAndRefresh
  • /clusters/{clusterName}/commands/deployClusterClientConfig
  • /clusters/{clusterName}/commands/disableTls
  • /clusters/{clusterName}/commands/enterMaintenanceMode
  • /clusters/{clusterName}/commands/exitMaintenanceMode
  • /clusters/{clusterName}/commands/expireLogs
  • /clusters/{clusterName}/commands/firstRun
  • /clusters/{clusterName}/commands/inspectHosts
  • /clusters/{clusterName}/commands/perfInspector
  • /clusters/{clusterName}/commands/poolsRefresh
  • /clusters/{clusterName}/commands/postClouderaRuntimeUpgrade
  • /clusters/{clusterName}/commands/preUpgradeCheck
  • /clusters/{clusterName}/commands/refresh
  • /clusters/{clusterName}/commands/restart
  • /clusters/{clusterName}/commands/rollingRestart
  • /clusters/{clusterName}/commands/rollingUpgrade
  • /clusters/{clusterName}/commands/start
  • /clusters/{clusterName}/commands/stop
  • /clusters/{clusterName}/commands/upgradeCdh
  • /clusters/{clusterName}/commands/upgradeServices
  • /clusters/{clusterName}/hosts/{hostId}
  • /clusters/{clusterName}/commands/tearDownWorkload/{workloadClusterName}
  • GET, POST
  • DELETE, GET, PUT
  • PUT
  • PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE, GET, POST
  • GET
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • DELETE
  • POST
The root of the Cloudera API (v5). Provides access to all sub-resources available in version 5 of the API.
CmPeersResource
  • /cm/peers
  • /cm/peers/{peerName}
  • /cm/peers/{peerName}/commands/test
  • GET, POST
  • DELETE, GET, PUT
  • POST
 
CommandsResource
  • /commands/commands
  • /commands/{commandId}
  • /commands/{commandId}/abort
  • /commands/{commandId}/download
  • /commands/{commandId}/retry
  • /commands/{commandId}/steps
  • /commands/{commandId}/logs/stderr
  • /commands/{commandId}/logs/stdout
  • GET
  • GET
  • POST
  • GET
  • POST
  • GET
  • GET
  • GET
 
ControlPlanesResource
  • /controlPlanes
  • /controlPlanes/{controlPlaneUuid}
  • /controlPlanes/commands/generateCopyDocker
  • /controlPlanes/commands/generateExternalVaultSetup
  • /controlPlanes/commands/installControlPlane
  • /controlPlanes/commands/installEmbeddedControlPlane
  • /controlPlanes/commands/upgradeEmbeddedControlPlane
  • /controlPlanes/fetchResources/manifest.json
  • /controlPlanes/{controlPlaneUuid}/getTaggedCluster
  • /controlPlanes/{controlPlaneUuid}/tags
  • /controlPlanes/fetchResources/{commandId}/logContent
  • /controlPlanes/{controlPlaneUuid}/commands/copyImagesInFeatures
  • /controlPlanes/{controlPlaneUuid}/commands/uninstallControlPlane
  • /controlPlanes/{controlPlaneUuid}/commands/updateControlPlaneValuesYaml
  • /controlPlanes/{controlPlaneUuid}/commands/upgradeControlPlane
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • DELETE, GET, PUT
  • POST
  • POST
  • POST
  • POST
  • POST
 
CspResource
  • /csp/uploadCspCert
  • PUT
Upload CA certificates, client certificates and client key for Credential Storage Provider. CM server restart is needed for these certificates to be applied.
DashboardsResource
  • /timeseries/dashboards
  • /timeseries/dashboards/{dashboardName}
  • GET, POST
  • DELETE, GET
 
DataContextsResource
  • /dataContexts
  • /dataContexts/{dataContextName}
  • GET, POST, PUT
  • DELETE, GET
 
EventsResource
  • /events
  • /events/{eventId}
  • GET
  • GET
 
ExternalAccountsResource
  • /externalAccounts/create
  • /externalAccounts/supportedCategories
  • /externalAccounts/update
  • /externalAccounts/account/{name}
  • /externalAccounts/accountByDisplayName/{displayName}
  • /externalAccounts/delete/{name}
  • /externalAccounts/supportedTypes/{categoryName}
  • /externalAccounts/type/{typeName}
  • /externalAccounts/account/{name}/config
  • /externalAccounts/typeInfo/{typeName}/commandsByName
  • /externalAccounts/account/{name}/commands/{commandName}
  • POST
  • GET
  • PUT
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET, PUT
  • GET
  • POST
Manage external accounts used by various Cloudera Manager features, for performing external tasks.
ExternalUserMappingsResource
  • /externalUserMappings
  • /externalUserMappings/{uuid}
  • GET, POST
  • DELETE, GET, PUT
 
HostTemplatesResource
  • /clusters/{clusterName}/hostTemplates
  • /clusters/{clusterName}/hostTemplates/{hostTemplateName}
  • /clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/applyHostTemplate
  • /clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/reapplyHostTemplateOnHosts
  • GET, POST
  • DELETE, GET, PUT
  • POST
  • POST
 
HostsResource
  • /hosts
  • /hosts/enterMaintenanceMode
  • /hosts/removeHostsFromCluster
  • /hosts/{hostId}
  • /hosts/{hostId}/components
  • /hosts/{hostId}/config
  • /hosts/{hostId}/metrics
  • /hosts/{hostname}/tags
  • /hosts/{hostId}/commands/enterMaintenanceMode
  • /hosts/{hostId}/commands/exitMaintenanceMode
  • /hosts/{hostId}/commands/generateHostCerts
  • /hosts/{hostId}/commands/migrateRoles
  • /hosts/{hostId}/commands/resetHostId
  • DELETE, GET, POST
  • POST
  • POST
  • DELETE, GET, PUT
  • GET
  • GET, PUT
  • GET
  • DELETE, GET, PUT
  • POST
  • POST
  • POST
  • POST
  • POST
 
ImpalaQueriesResource
  • /clusters/{clusterName}/services/{serviceName}/impalaQueries
  • /clusters/{clusterName}/services/{serviceName}/impalaQueries/attributes
  • /clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId}
  • /clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId}/cancel
  • GET
  • GET
  • GET
  • POST
 
MgmtRoleCommandsResource
  • /cm/service/roleCommands/jmapDump
  • /cm/service/roleCommands/jmapHisto
  • /cm/service/roleCommands/jstack
  • /cm/service/roleCommands/lsof
  • /cm/service/roleCommands/restart
  • /cm/service/roleCommands/start
  • /cm/service/roleCommands/stop
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
 
MgmtRoleConfigGroupsResource
  • /cm/service/roleConfigGroups
  • /cm/service/roleConfigGroups/{roleConfigGroupName}
  • /cm/service/roleConfigGroups/{roleConfigGroupName}/config
  • /cm/service/roleConfigGroups/{roleConfigGroupName}/roles
  • GET
  • GET, PUT
  • GET, PUT
  • GET
 
MgmtRolesResource
  • /cm/service/roles
  • /cm/service/roles/{roleName}
  • /cm/service/roles/{roleName}/commands
  • /cm/service/roles/{roleName}/config
  • /cm/service/roles/{roleName}/commands/enterMaintenanceMode
  • /cm/service/roles/{roleName}/commands/exitMaintenanceMode
  • /cm/service/roles/{roleName}/logs/full
  • /cm/service/roles/{roleName}/logs/stacks
  • /cm/service/roles/{roleName}/logs/stacksBundle
  • /cm/service/roles/{roleName}/logs/stderr
  • /cm/service/roles/{roleName}/logs/stdout
  • GET, POST
  • DELETE, GET
  • GET
  • GET, PUT
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
 
MgmtServiceResource
  • /cm/service
  • /cm/service/autoAssignRoles
  • /cm/service/autoConfigure
  • /cm/service/commands
  • /cm/service/config
  • /cm/service/roleTypes
  • /cm/service/commands/enterMaintenanceMode
  • /cm/service/commands/exitMaintenanceMode
  • /cm/service/commands/restart
  • /cm/service/commands/start
  • /cm/service/commands/stop
  • DELETE, GET, PUT
  • PUT
  • PUT
  • GET
  • GET, PUT
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
 
NameservicesResource
  • /clusters/{clusterName}/services/{serviceName}/nameservices
  • /clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}
  • /clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}/metrics
  • GET
  • GET
  • GET
 
ParcelResource
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/activate
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDistribution
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDownload
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/deactivate
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/removeDownload
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDistribution
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDownload
  • /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startRemovalOfDistribution
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
This interface describes a parcel resource and all the operations that can be performed on it. All the commands in this resource are modeled as follows: When you execute a command, for example startDownload, that command simply starts the download and returns right away. This is why they are labeled as a synchronous commands. In order to see the progress of the command a call to readParcel() needs to be made. This will show the current stage and any progress information if the parcel is in a transition stage. Eg. DOWNLOADING, DISTRIBUTING etc. If the command for some reason could not execute properly, an error is returned to the user as part of the synchronous command. A Parcel goes through many stages during its lifecycle. The various stages and their order is described on in ApiParcel
ParcelsResource
  • /clusters/{clusterName}/parcels
  • /clusters/{clusterName}/parcels/usage
  • GET
  • GET
 
ProcessResource
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/process
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/process/configFiles/{configFileName}
  • GET
  • GET
 
ReplicationsResource
  • /clusters/{clusterName}/services/{serviceName}/replications
  • /clusters/{clusterName}/services/{serviceName}/replications/createCloudCredstoreOnHdfs
  • /clusters/{clusterName}/services/{serviceName}/replications/createCredstore
  • /clusters/{clusterName}/services/{serviceName}/replications/exportRangerServices
  • /clusters/{clusterName}/services/{serviceName}/replications/generateCloudReplCredstorePassword
  • /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationSecurityTool
  • /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationValidationTool
  • /clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing
  • /clusters/{clusterName}/services/{serviceName}/replications/hiveReplicationQuery
  • /clusters/{clusterName}/services/{serviceName}/replications/isHive3ReverseDirectionEnabled
  • /clusters/{clusterName}/services/{serviceName}/replications/recreateCloudCredstoresOnHdfs
  • /clusters/{clusterName}/services/{serviceName}/replications/replicationState
  • /clusters/{clusterName}/services/{serviceName}/replications/rescheduleHive3ReplicationMetricsGetter
  • /clusters/{clusterName}/services/{serviceName}/replications/updateHBasePeerState
  • /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/addReplicationPeer
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/addTablesToHBasePeer
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/checkTables
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/fetchColumnFamilies
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/fetchHBasePeerInfo
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/listNamespaces
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/listPeers
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/listTables
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/removeHBasePeer
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/removeTablesFromHBasePeer
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/setCFsReplicationScope
  • /clusters/{clusterName}/services/{serviceName}/replications/operations/updateReplicationPeerState
  • /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/collectDiagnosticData
  • /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/forcedDelete
  • /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/history
  • /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/run
  • /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/runHBaseReplicationRetryFailedSnapshots
  • DELETE, GET, POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • POST
  • PUT
  • DELETE, GET, PUT
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • DELETE
  • GET
  • POST
  • POST
 
RoleCommandsResource
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsBootstrapStandBy
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsEnterSafemode
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsFinalizeMetadataUpgrade
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsFormat
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsInitializeAutoFailover
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsInitializeSharedDir
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsLeaveSafemode
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsSaveNamespace
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/hueSyncDb
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/jmapDump
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/jmapHisto
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/jstack
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/lsof
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/refresh
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/restart
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/start
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/stop
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/zooKeeperCleanup
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/zooKeeperInit
  • /clusters/{clusterName}/services/{serviceName}/roleCommands/{commandName}
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
 
RoleConfigGroupsResource
  • /clusters/{clusterName}/services/{serviceName}/roleConfigGroups
  • /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/roles
  • /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}
  • /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/config
  • /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/roles
  • GET, POST
  • PUT
  • DELETE, GET, PUT
  • GET, PUT
  • GET, PUT
 
RolesResource
  • /clusters/{clusterName}/services/{serviceName}/roles
  • /clusters/{clusterName}/services/{serviceName}/roles/bulkDelete
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commandsByName
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/config
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/metrics
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/tags
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/enterMaintenanceMode
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/exitMaintenanceMode
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/impalaDiagnostics
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/full
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stacks
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stacksBundle
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stderr
  • /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stdout
  • GET, POST
  • POST
  • DELETE, GET
  • GET
  • GET
  • GET, PUT
  • GET
  • DELETE, GET, PUT
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
 
ServicesResource
  • /clusters/{clusterName}/services
  • /clusters/{clusterName}/services/{serviceName}
  • /clusters/{clusterName}/services/{serviceName}/clientConfig
  • /clusters/{clusterName}/services/{serviceName}/commands
  • /clusters/{clusterName}/services/{serviceName}/commandsByName
  • /clusters/{clusterName}/services/{serviceName}/config
  • /clusters/{clusterName}/services/{serviceName}/impalaUtilization
  • /clusters/{clusterName}/services/{serviceName}/metrics
  • /clusters/{clusterName}/services/{serviceName}/roleTypes
  • /clusters/{clusterName}/services/{serviceName}/tags
  • /clusters/{clusterName}/services/{serviceName}/yarnUtilization
  • /clusters/{clusterName}/services/{serviceName}/commands/copyHdfsFile
  • /clusters/{clusterName}/services/{serviceName}/commands/createHdfsFile
  • /clusters/{clusterName}/services/{serviceName}/commands/createOozieDb
  • /clusters/{clusterName}/services/{serviceName}/commands/createSolrHdfsHomeDir
  • /clusters/{clusterName}/services/{serviceName}/commands/createSqoopUserDir
  • /clusters/{clusterName}/services/{serviceName}/commands/decommission
  • /clusters/{clusterName}/services/{serviceName}/commands/deleteHdfsPath
  • /clusters/{clusterName}/services/{serviceName}/commands/deployClientConfig
  • /clusters/{clusterName}/services/{serviceName}/commands/disableJtHa
  • /clusters/{clusterName}/services/{serviceName}/commands/disableRmHa
  • /clusters/{clusterName}/services/{serviceName}/commands/disableSentryHa
  • /clusters/{clusterName}/services/{serviceName}/commands/enableJtHa
  • /clusters/{clusterName}/services/{serviceName}/commands/enableRmHa
  • /clusters/{clusterName}/services/{serviceName}/commands/enableSentryHa
  • /clusters/{clusterName}/services/{serviceName}/commands/enterMaintenanceMode
  • /clusters/{clusterName}/services/{serviceName}/commands/exitMaintenanceMode
  • /clusters/{clusterName}/services/{serviceName}/commands/exportSentryPermissions
  • /clusters/{clusterName}/services/{serviceName}/commands/firstRun
  • /clusters/{clusterName}/services/{serviceName}/commands/getServicesFromRanger
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateRoot
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateUserDirectory
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupAutomatic
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupCleanAndReset
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupForceReady
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupManual
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupManualContinue
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupReset
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupStatus
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationSetup
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationSetupAdmin
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseShellCommand
  • /clusters/{clusterName}/services/{serviceName}/commands/hbaseUpgrade
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsAddSBNNToNS
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsCreateTmpDir
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableAutoFailover
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableHa
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableNnHa
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableAutoFailover
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableHa
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableNnHa
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsFailover
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsFinalizeRollingUpgrade
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsRollEdits
  • /clusters/{clusterName}/services/{serviceName}/commands/hdfsUpgradeMetadata
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveUserDir
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouse
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouseExternal
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabase
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabaseTables
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveUpdateMetastoreNamenodes
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveUpgradeMetastore
  • /clusters/{clusterName}/services/{serviceName}/commands/hiveValidateMetastoreSchema
  • /clusters/{clusterName}/services/{serviceName}/commands/hueCreateHiveWarehouse
  • /clusters/{clusterName}/services/{serviceName}/commands/hueDumpDb
  • /clusters/{clusterName}/services/{serviceName}/commands/hueLoadDb
  • /clusters/{clusterName}/services/{serviceName}/commands/hueSyncDb
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabase
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabaseTables
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaCreateUserDir
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaHa
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaRm
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaHa
  • /clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaRm
  • /clusters/{clusterName}/services/{serviceName}/commands/importMrConfigsIntoYarn
  • /clusters/{clusterName}/services/{serviceName}/commands/initSolr
  • /clusters/{clusterName}/services/{serviceName}/commands/installMrFrameworkJars
  • /clusters/{clusterName}/services/{serviceName}/commands/installOozieShareLib
  • /clusters/{clusterName}/services/{serviceName}/commands/migrateToSentry
  • /clusters/{clusterName}/services/{serviceName}/commands/offline
  • /clusters/{clusterName}/services/{serviceName}/commands/oozieCreateEmbeddedDatabase
  • /clusters/{clusterName}/services/{serviceName}/commands/oozieDisableHa
  • /clusters/{clusterName}/services/{serviceName}/commands/oozieDumpDatabase
  • /clusters/{clusterName}/services/{serviceName}/commands/oozieEnableHa
  • /clusters/{clusterName}/services/{serviceName}/commands/oozieLoadDatabase
  • /clusters/{clusterName}/services/{serviceName}/commands/oozieUpgradeDb
  • /clusters/{clusterName}/services/{serviceName}/commands/recommission
  • /clusters/{clusterName}/services/{serviceName}/commands/recommissionWithStart
  • /clusters/{clusterName}/services/{serviceName}/commands/restart
  • /clusters/{clusterName}/services/{serviceName}/commands/rollingRestart
  • /clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabase
  • /clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabaseTables
  • /clusters/{clusterName}/services/{serviceName}/commands/sentryUpgradeDatabaseTables
  • /clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapCollections
  • /clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapConfig
  • /clusters/{clusterName}/services/{serviceName}/commands/solrConfigBackup
  • /clusters/{clusterName}/services/{serviceName}/commands/solrMigrateSentryPrivilegesCommand
  • /clusters/{clusterName}/services/{serviceName}/commands/solrReinitializeStateForUpgrade
  • /clusters/{clusterName}/services/{serviceName}/commands/solrValidateMetadata
  • /clusters/{clusterName}/services/{serviceName}/commands/sqoopCreateDatabaseTables
  • /clusters/{clusterName}/services/{serviceName}/commands/sqoopUpgradeDb
  • /clusters/{clusterName}/services/{serviceName}/commands/start
  • /clusters/{clusterName}/services/{serviceName}/commands/stop
  • /clusters/{clusterName}/services/{serviceName}/commands/switchToMr2
  • /clusters/{clusterName}/services/{serviceName}/commands/yarnApplicationDiagnosticsCollection
  • /clusters/{clusterName}/services/{serviceName}/commands/yarnCreateCmContainerUsageInputDirCommand
  • /clusters/{clusterName}/services/{serviceName}/commands/yarnCreateJobHistoryDirCommand
  • /clusters/{clusterName}/services/{serviceName}/commands/yarnFormatStateStore
  • /clusters/{clusterName}/services/{serviceName}/commands/yarnNodeManagerRemoteAppLogDirCommand
  • /clusters/{clusterName}/services/{serviceName}/commands/zooKeeperCleanup
  • /clusters/{clusterName}/services/{serviceName}/commands/zooKeeperInit
  • /clusters/{clusterName}/services/{serviceName}/commands/{commandName}
  • /clusters/{clusterName}/services/{serviceName}/reports/hdfsUsageReport
  • /clusters/{clusterName}/services/{serviceName}/reports/mrUsageReport
  • GET, POST
  • DELETE, GET, PUT
  • GET
  • GET
  • GET
  • GET, PUT
  • GET
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • DELETE
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
 
SnapshotsResource
  • /clusters/{clusterName}/services/{serviceName}/snapshots
  • /clusters/{clusterName}/services/{serviceName}/snapshots/policies
  • /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}
  • /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}/history
  • POST
  • GET, POST
  • DELETE, GET, PUT
  • GET
Available since API v6. Only available with Cloudera Manager Enterprise Edition.
TagsResource
  • /tags
  • /tags/{tagName}
  • GET
  • GET
 
TimeSeriesResource
  • /timeseries
  • /timeseries/entityTypeAttributes
  • /timeseries/entityTypes
  • /timeseries/schema
  • GET, POST
  • GET
  • GET
  • GET
 
ToolsResource
  • /tools/echo
  • /tools/echoError
  • GET
  • GET
 
UsersResource
  • /users
  • /users/sessions
  • /users/{userName}
  • /users/expireSessions/{userName}
  • GET, POST
  • GET
  • DELETE, GET, PUT
  • POST
 
WatchedDirResource
  • /clusters/{clusterName}/services/{serviceName}/watcheddir
  • /clusters/{clusterName}/services/{serviceName}/watcheddir/{directoryPath}
  • GET, POST
  • DELETE
 
YarnApplicationsResource
  • /clusters/{clusterName}/services/{serviceName}/yarnApplications
  • /clusters/{clusterName}/services/{serviceName}/yarnApplications/attributes
  • /clusters/{clusterName}/services/{serviceName}/yarnApplications/{applicationId}/kill
  • GET
  • GET
  • POST