Introduced in Cloudera Manager 7.0.3
Cloudera Product Documentation
This Python package is automatically generated by the Swagger Codegen project:
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import cm_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import cm_client
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
cm_client.configuration.username = 'YOUR_USERNAME'
cm_client.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = cm_client.ActivitiesResourceApi()
activity_id = 'activity_id_example' # str | The name of the activity.
cluster_name = 'cluster_name_example' # str | The name of the cluster.
service_name = 'service_name_example' # str | The name of the service.
_from = '_from_example' # str | Start of the period to query. (optional)
metrics = ['metrics_example'] # list[str] | Filter for which metrics to query. (optional)
to = 'now' # str | End of the period to query. (optional) (default to now)
view = 'summary' # str | The view of the data to materialize, either \"summary\" or \"full\". (optional) (default to summary)
try:
# Fetch metric readings for a particular activity.
api_response = api_instance.get_metrics(activity_id, cluster_name, service_name, _from=_from, metrics=metrics, to=to, view=view)
pprint(api_response)
except ApiException as e:
print("Exception when calling ActivitiesResourceApi->get_metrics: %s\n" % e)
All URIs are relative to https://localhost/api/v40
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActivitiesResourceApi | get_metrics | GET /clusters/{clusterName}/services/{serviceName}/activities/{activityId}/metrics | Fetch metric readings for a particular activity. |
| ActivitiesResourceApi | read_activities | GET /clusters/{clusterName}/services/{serviceName}/activities | Read all activities in the system. |
| ActivitiesResourceApi | read_activity | GET /clusters/{clusterName}/services/{serviceName}/activities/{activityId} | Returns a specific activity in the system. |
| ActivitiesResourceApi | read_child_activities | GET /clusters/{clusterName}/services/{serviceName}/activities/{activityId}/children | Returns the child activities. |
| ActivitiesResourceApi | read_similar_activities | GET /clusters/{clusterName}/services/{serviceName}/activities/{activityId}/similar | Returns a list of similar activities. |
| AllHostsResourceApi | read_config | GET /cm/allHosts/config | Retrieve the default configuration for all hosts. |
| AllHostsResourceApi | update_config | PUT /cm/allHosts/config | Update the default configuration values for all hosts. |
| AuditsResourceApi | read_audits | GET /audits | Fetch audit events from Cloudera Manager (CM) and CM managed services like HDFS, HBase, Impala, Hive, and Sentry. |
| AuditsResourceApi | stream_audits | GET /audits/stream | |
| AuthRoleMetadatasResourceApi | read_auth_roles_metadata | GET /authRoleMetadatas | Returns a list of the auth roles' metadata for the built-in roles. |
| AuthRolesResourceApi | create_auth_roles | POST /authRoles | Creates a list of auth roles. |
| AuthRolesResourceApi | delete_auth_role | DELETE /authRoles/{uuid} | Deletes an auth role from the system. |
| AuthRolesResourceApi | read_auth_role | GET /authRoles/{uuid} | Returns detailed information about an auth role. |
| AuthRolesResourceApi | read_auth_roles | GET /authRoles | Returns a list of the auth roles configured in the system. |
| AuthRolesResourceApi | read_auth_roles_metadata | GET /authRoles/metadata | Returns a list of the auth roles' metadata for the built-in roles. |
| AuthRolesResourceApi | update_auth_role | PUT /authRoles/{uuid} | Updates the given auth role's information. |
| AuthServiceResourceApi | auto_assign_roles | PUT /cm/authService/autoAssignRoles | Automatically assign roles to hosts and create the roles for the Authentication Service. |
| AuthServiceResourceApi | auto_configure | PUT /cm/authService/autoConfigure | Automatically configures roles of the Authentication Service. |
| AuthServiceResourceApi | delete | DELETE /cm/authService | Delete the Authentication Service. |
| AuthServiceResourceApi | enter_maintenance_mode | POST /cm/authService/commands/enterMaintenanceMode | Put the Authentication Service into maintenance mode. |
| AuthServiceResourceApi | exit_maintenance_mode | POST /cm/authService/commands/exitMaintenanceMode | Take the Authentication Service out of maintenance mode. |
| AuthServiceResourceApi | list_active_commands | GET /cm/authService/commands | List active Authentication Service commands. |
| AuthServiceResourceApi | list_role_types | GET /cm/authService/roleTypes | List the supported role types for the Authentication Service. |
| AuthServiceResourceApi | read_service | GET /cm/authService | Retrieve information about the Authentication Services. |
| AuthServiceResourceApi | read_service_config | GET /cm/authService/config | |
| AuthServiceResourceApi | restart_command | POST /cm/authService/commands/restart | Restart the Authentication Service. |
| AuthServiceResourceApi | setup | PUT /cm/authService | Setup the Authentication Service. |
| AuthServiceResourceApi | start_command | POST /cm/authService/commands/start | Start the Authentication Service. |
| AuthServiceResourceApi | stop_command | POST /cm/authService/commands/stop | Stop the Authentication Service. |
| AuthServiceResourceApi | update_service_config | PUT /cm/authService/config | |
| AuthServiceRoleCommandsResourceApi | restart_command | POST /cm/authService/roleCommands/restart | Restart a set of Authentication Service roles. |
| AuthServiceRoleCommandsResourceApi | start_command | POST /cm/authService/roleCommands/start | Start a set of Authentication Service roles. |
| AuthServiceRoleCommandsResourceApi | stop_command | POST /cm/authService/roleCommands/stop | Stop a set of Authentication Service roles. |
| AuthServiceRoleConfigGroupsResourceApi | read_config | GET /cm/authService/roleConfigGroups/{roleConfigGroupName}/config | Returns the current revision of the config for the specified role config group in the Authentication Service. |
| AuthServiceRoleConfigGroupsResourceApi | read_role_config_group | GET /cm/authService/roleConfigGroups/{roleConfigGroupName} | Returns the information for a given role config group in the Authentication Service. |
| AuthServiceRoleConfigGroupsResourceApi | read_role_config_groups | GET /cm/authService/roleConfigGroups | Returns the information for all role config groups in the Authentication Service. |
| AuthServiceRoleConfigGroupsResourceApi | read_roles | GET /cm/authService/roleConfigGroups/{roleConfigGroupName}/roles | Returns all roles in the given role config group in the Authentication Service. |
| AuthServiceRoleConfigGroupsResourceApi | update_config | PUT /cm/authService/roleConfigGroups/{roleConfigGroupName}/config | Updates the config for the given role config group in the Authentication Service. |
| AuthServiceRoleConfigGroupsResourceApi | update_role_config_group | PUT /cm/authService/roleConfigGroups/{roleConfigGroupName} | Updates an existing role config group in the Authentication Service. |
| AuthServiceRolesResourceApi | create_roles | POST /cm/authService/roles | Create new roles in the Authentication Services. |
| AuthServiceRolesResourceApi | delete_role | DELETE /cm/authService/roles/{roleName} | Delete a role from the Authentication Services. |
| AuthServiceRolesResourceApi | enter_maintenance_mode | POST /cm/authService/roles/{roleName}/commands/enterMaintenanceMode | Put the Authentication Service role into maintenance mode. |
| AuthServiceRolesResourceApi | exit_maintenance_mode | POST /cm/authService/roles/{roleName}/commands/exitMaintenanceMode | Take the Authentication Service role out of maintenance mode. |
| AuthServiceRolesResourceApi | get_full_log | GET /cm/authService/roles/{roleName}/logs/full | Retrieves the log file for the role's main process. |
| AuthServiceRolesResourceApi | get_stacks_log | GET /cm/authService/roles/{roleName}/logs/stacks | Retrieves the stacks log file, if any, for the role's main process. |
| AuthServiceRolesResourceApi | get_stacks_logs_bundle | GET /cm/authService/roles/{roleName}/logs/stacksBundle | Download a zip-compressed archive of role stacks logs. |
| AuthServiceRolesResourceApi | get_standard_error | GET /cm/authService/roles/{roleName}/logs/stderr | Retrieves the role's standard error output. |
| AuthServiceRolesResourceApi | get_standard_output | GET /cm/authService/roles/{roleName}/logs/stdout | Retrieves the role's standard output. |
| AuthServiceRolesResourceApi | list_active_commands | GET /cm/authService/roles/{roleName}/commands | List active role commands. |
| AuthServiceRolesResourceApi | read_role | GET /cm/authService/roles/{roleName} | Retrieve detailed information about a Authentication Services role. |
| AuthServiceRolesResourceApi | read_role_config | GET /cm/authService/roles/{roleName}/config | Retrieve the configuration of a specific Authentication Services role. |
| AuthServiceRolesResourceApi | read_roles | GET /cm/authService/roles | List all roles of the Authentication Services. |
| AuthServiceRolesResourceApi | update_role_config | PUT /cm/authService/roles/{roleName}/config | Update the configuration of a Authentication Services role. |
| BatchResourceApi | execute | POST /batch | Executes a batch of API requests in one database transaction. |
| CdpResourceApi | get_remote_context | GET /cdp/remoteContext/byContext/{dataContextName} | Get a JSON for creating a remote data context in a Workload cluster. |
| CdpResourceApi | get_remote_context_by_cluster | GET /cdp/remoteContext/byCluster/{clusterName} | Get a JSON for creating a remote data context in a Workload cluster. |
| CdpResourceApi | post_remote_context | POST /cdp/remoteContext | Create or update the remote data context in the Workload cluster. |
| CertManagerResourceApi | generate_certificate | POST /certs/generateCertificate | Exchange a cert request token for a certificate. |
| ClouderaManagerResourceApi | add_custom_certs | POST /cm/commands/addCustomCerts | Add custom certificates to the Auto-TLS certificate database. |
| ClouderaManagerResourceApi | begin_trial | POST /cm/trial/begin | Begin trial license. |
| ClouderaManagerResourceApi | clusters_perf_inspector_command | POST /cm/commands/clustersPerfInspector | Run performance diagnostics test against specified clusters in ApiClustersPerfInspectorArgs User must be Full Administrator or Global Cluster Administrator. |
| ClouderaManagerResourceApi | collect_diagnostic_data_command | POST /cm/commands/collectDiagnosticData | Collect diagnostic data from hosts managed by Cloudera Manager. |
| ClouderaManagerResourceApi | delete_credentials_command | POST /cm/commands/deleteCredentials | Delete existing Kerberos credentials. |
| ClouderaManagerResourceApi | end_trial | POST /cm/trial/end | End trial license. |
| ClouderaManagerResourceApi | generate_cmca | POST /cm/commands/generateCmca | Generate a CMCA. |
| ClouderaManagerResourceApi | generate_credentials_command | POST /cm/commands/generateCredentials | Generate missing Kerberos credentials. |
| ClouderaManagerResourceApi | get_config | GET /cm/config | Retrieve the Cloudera Manager settings. |
| ClouderaManagerResourceApi | get_deployment2 | GET /cm/deployment | Retrieve full description of the entire Cloudera Manager deployment including all hosts, clusters, services, roles, users, settings, etc. |
| ClouderaManagerResourceApi | get_kerberos_info | GET /cm/kerberosInfo | Provides Cloudera Manager Kerberos information. |
| ClouderaManagerResourceApi | get_kerberos_principals | GET /cm/kerberosPrincipals | Returns the Kerberos principals needed by the services being managed by Cloudera Manager. |
| ClouderaManagerResourceApi | get_licensed_feature_usage | GET /cm/licensedFeatureUsage | Retrieve a summary of licensed feature usage. |
| ClouderaManagerResourceApi | get_log | GET /cm/log | Returns the entire contents of the Cloudera Manager log file. |
| ClouderaManagerResourceApi | get_scm_db_info | GET /cm/scmDbInfo | Provides Cloudera Manager server's database information. |
| ClouderaManagerResourceApi | get_shutdown_readiness | GET /cm/shutdownReadiness | Retrieve Cloudera Manager's readiness for shutdown and destroy. |
| ClouderaManagerResourceApi | get_version | GET /cm/version | Provides version information of Cloudera Manager itself. |
| ClouderaManagerResourceApi | host_install_command | POST /cm/commands/hostInstall | Perform installation on a set of hosts. |
| ClouderaManagerResourceApi | hosts_decommission_command | POST /cm/commands/hostsDecommission | Decommission the given hosts. |
| ClouderaManagerResourceApi | hosts_offline_or_decommission_command | POST /cm/commands/hostsOfflineOrDecommission | Decommission the given hosts. |
| ClouderaManagerResourceApi | hosts_perf_inspector_command | POST /cm/commands/hostsPerfInspector | Run performance diagnostics test against specified hosts in ApiHostsPerfInspectorArgs User must be Full Administrator or Global Cluster Administrator. |
| ClouderaManagerResourceApi | hosts_recommission_and_exit_maintenance_mode_command | POST /cm/commands/hostsRecommissionAndExitMaintenanceMode | Recommission and exit maintenance on the given hosts. |
| ClouderaManagerResourceApi | hosts_recommission_command | POST /cm/commands/hostsRecommission | Recommission the given hosts. |
| ClouderaManagerResourceApi | hosts_recommission_with_start_command | POST /cm/commands/hostsRecommissionWithStart | Recommission the given hosts. |
| ClouderaManagerResourceApi | hosts_start_roles_command | POST /cm/commands/hostsStartRoles | Start all the roles on the given hosts. |
| ClouderaManagerResourceApi | import_admin_credentials | POST /cm/commands/importAdminCredentials | Imports the KDC Account Manager credentials needed by Cloudera Manager to create kerberos principals needed by CDH services. |
| ClouderaManagerResourceApi | import_cluster_template | POST /cm/importClusterTemplate | Create cluster as per the given cluster template. |
| ClouderaManagerResourceApi | import_kerberos_principal | POST /cm/commands/importKerberosPrincipal | Imports the Kerberos credentials for the specified principal which can then be used to add to a role's keytab by running Generate Credentials command. |
| ClouderaManagerResourceApi | inspect_hosts_command | POST /cm/commands/inspectHosts | Runs the host inspector on the configured hosts. |
| ClouderaManagerResourceApi | list_active_commands | GET /cm/commands | List active global commands. |
| ClouderaManagerResourceApi | read_license | GET /cm/license | Retrieve information about the Cloudera Manager license. |
| ClouderaManagerResourceApi | refresh_parcel_repos | POST /cm/commands/refreshParcelRepos | . |
| ClouderaManagerResourceApi | update_config | PUT /cm/config | Update the Cloudera Manager settings. |
| ClouderaManagerResourceApi | update_deployment2 | PUT /cm/deployment | Apply the supplied deployment description to the system. |
| ClouderaManagerResourceApi | update_license | POST /cm/license | Updates the Cloudera Manager license. |
| ClustersResourceApi | add_hosts | POST /clusters/{clusterName}/hosts | |
| ClustersResourceApi | auto_assign_roles | PUT /clusters/{clusterName}/autoAssignRoles | Automatically assign roles to hosts and create the roles for all the services in a cluster. |
| ClustersResourceApi | auto_configure | PUT /clusters/{clusterName}/autoConfigure | Automatically configures roles and services in a cluster. |
| ClustersResourceApi | configure_auto_tls_services_command | POST /clusters/{clusterName}/commands/configureAutoTlsServices | Configures all services in a cluster to use Auto-TLS. |
| ClustersResourceApi | configure_for_kerberos | POST /clusters/{clusterName}/commands/configureForKerberos | Command to configure the cluster to use Kerberos for authentication. |
| ClustersResourceApi | create_clusters | POST /clusters | Creates a collection of clusters. |
| ClustersResourceApi | delete_cluster | DELETE /clusters/{clusterName} | Deletes a cluster. |
| ClustersResourceApi | delete_cluster_credentials_command | POST /clusters/{clusterName}/commands/deleteCredentials | Delete existing Kerberos credentials for the cluster. |
| ClustersResourceApi | deploy_client_config | POST /clusters/{clusterName}/commands/deployClientConfig | Deploy the cluster-wide client configuration. |
| ClustersResourceApi | deploy_client_configs_and_refresh | POST /clusters/{clusterName}/commands/deployClientConfigsAndRefresh | Performs a command with the 2 steps - deploy cc - cluster refresh This orchestration is needed for the staleness wizard, so it can invoke a single command at wizard finish. |
| ClustersResourceApi | deploy_cluster_client_config | POST /clusters/{clusterName}/commands/deployClusterClientConfig | Deploy the Cluster's Kerberos client configuration. |
| ClustersResourceApi | enter_maintenance_mode | POST /clusters/{clusterName}/commands/enterMaintenanceMode | Put the cluster into maintenance mode. |
| ClustersResourceApi | exit_maintenance_mode | POST /clusters/{clusterName}/commands/exitMaintenanceMode | Take the cluster out of maintenance mode. |
| ClustersResourceApi | expire_logs | POST /clusters/{clusterName}/commands/expireLogs | Remove backup and disaster related log files in hdfs. |
| ClustersResourceApi | export | GET /clusters/{clusterName}/export | Export the cluster template for the given cluster. |
| ClustersResourceApi | first_run | POST /clusters/{clusterName}/commands/firstRun | Prepare and start services in a cluster. |
| ClustersResourceApi | get_client_config | GET /clusters/{clusterName}/clientConfig | Download a zip-compressed archive of the client configuration, of a specific cluster. |
| ClustersResourceApi | get_kerberos_info | GET /clusters/{clusterName}/kerberosInfo | Provides Cluster Kerberos information. |
| ClustersResourceApi | get_utilization_report | GET /clusters/{clusterName}/utilization | Provides the resource utilization of the entire cluster as well as the resource utilization per tenant. |
| ClustersResourceApi | inspect_hosts_command | POST /clusters/{clusterName}/commands/inspectHosts | Runs the host inspector on the configured hosts in the specified cluster. |
| ClustersResourceApi | list_active_commands | GET /clusters/{clusterName}/commands | List active cluster commands. |
| ClustersResourceApi | list_dfs_services | GET /clusters/{clusterName}/dfsServices | List the services that can provide distributed file system (DFS) capabilities in this cluster. |
| ClustersResourceApi | list_hosts | GET /clusters/{clusterName}/hosts | Returns the hosts associated with the cluster filtered by optional host configuration parameter, if specified. |
| ClustersResourceApi | list_service_types | GET /clusters/{clusterName}/serviceTypes | List the supported service types for a cluster. |
| ClustersResourceApi | list_upgrade_domains | GET /clusters/{clusterName}/upgradeDomains | Returns the Upgrade Domains associated with the cluster and the host names that belong to each Upgrade Domain. |
| ClustersResourceApi | perf_inspector_command | POST /clusters/{clusterName}/commands/perfInspector | Run cluster performance diagnostics test. |
| ClustersResourceApi | pools_refresh | POST /clusters/{clusterName}/commands/poolsRefresh | Updates all refreshable configuration files for services with Dynamic Resource Pools. |
| ClustersResourceApi | pre_upgrade_check_command | POST /clusters/{clusterName}/commands/preUpgradeCheck | Run cluster pre-upgrade check(s) when upgrading from specified version of CDH to the other. |
| ClustersResourceApi | read_cluster | GET /clusters/{clusterName} | Reads information about a cluster. |
| ClustersResourceApi | read_clusters | GET /clusters | List all known clusters. |
| ClustersResourceApi | refresh | POST /clusters/{clusterName}/commands/refresh | Updates all refreshable configuration files in the cluster. |
| ClustersResourceApi | remove_all_hosts | DELETE /clusters/{clusterName}/hosts | |
| ClustersResourceApi | remove_host | DELETE /clusters/{clusterName}/hosts/{hostId} | |
| ClustersResourceApi | restart_command | POST /clusters/{clusterName}/commands/restart | Restart all services in the cluster. |
| ClustersResourceApi | rolling_restart | POST /clusters/{clusterName}/commands/rollingRestart | Command to do a "best-effort" rolling restart of the given cluster, i. |
| ClustersResourceApi | rolling_upgrade | POST /clusters/{clusterName}/commands/rollingUpgrade | Command to do a rolling upgrade of specific services in the given cluster This command does not handle any services that don't support rolling upgrades. |
| ClustersResourceApi | start_command | POST /clusters/{clusterName}/commands/start | Start all services in the cluster. |
| ClustersResourceApi | stop_command | POST /clusters/{clusterName}/commands/stop | Stop all services in the cluster. |
| ClustersResourceApi | update_cluster | PUT /clusters/{clusterName} | Update an existing cluster. |
| ClustersResourceApi | upgrade_cdh_command | POST /clusters/{clusterName}/commands/upgradeCdh | Perform CDH upgrade to the specified version. |
| ClustersResourceApi | upgrade_services_command | POST /clusters/{clusterName}/commands/upgradeServices | Upgrades the services in the cluster to the CDH5 version. |
| CmPeersResourceApi | create_peer | POST /cm/peers | Create a new Cloudera Manager peer. |
| CmPeersResourceApi | delete_peer | DELETE /cm/peers/{peerName} | Delete Cloudera Manager peer. |
| CmPeersResourceApi | list_peers | GET /cm/peers | Retrieves all configured Cloudera Manager peers. |
| CmPeersResourceApi | read_peer | GET /cm/peers/{peerName} | Fetch information about an existing Cloudera Manager peer. |
| CmPeersResourceApi | test_peer | POST /cm/peers/{peerName}/commands/test | Test the connectivity of a peer. |
| CmPeersResourceApi | update_peer | PUT /cm/peers/{peerName} | Update information for a Cloudera Manager peer. |
| CommandsResourceApi | abort_command | POST /commands/{commandId}/abort | Abort a running command. |
| CommandsResourceApi | get_standard_error | GET /commands/{commandId}/logs/stderr | Download a zip-compressed archive of standard error outputs for the command's one-off processes. |
| CommandsResourceApi | get_standard_output | GET /commands/{commandId}/logs/stdout | Download a zip-compressed archive of standard outputs for the command's one-off processes. |
| CommandsResourceApi | read_command | GET /commands/{commandId} | Retrieve detailed information on an asynchronous command. |
| CommandsResourceApi | retry | POST /commands/{commandId}/retry | Try to rerun a command. |
| DashboardsResourceApi | create_dashboards | POST /timeseries/dashboards | Creates the list of dashboards. |
| DashboardsResourceApi | delete_dashboard | DELETE /timeseries/dashboards/{dashboardName} | Deletes a dashboard. |
| DashboardsResourceApi | get_dashboard | GET /timeseries/dashboards/{dashboardName} | Returns a dashboard definition for the specified name. |
| DashboardsResourceApi | get_dashboards | GET /timeseries/dashboards | Returns the list of all user-customized dashboards. |
| DataContextsResourceApi | create_data_context | POST /dataContexts | Create a datacontext. |
| DataContextsResourceApi | delete_data_context | DELETE /dataContexts/{dataContextName} | Delete a datacontext. |
| DataContextsResourceApi | read_data_context | GET /dataContexts/{dataContextName} | Reads information about a datacontext. |
| DataContextsResourceApi | read_data_contexts | GET /dataContexts | Get all the datacontexts. |
| EventsResourceApi | read_event | GET /events/{eventId} | Returns a specific event in the system. |
| EventsResourceApi | read_events | GET /events | Allows you to query events in the system. |
| ExternalAccountsResourceApi | create_account | POST /externalAccounts/create | Create a new external account. |
| ExternalAccountsResourceApi | delete_account | DELETE /externalAccounts/delete/{name} | Delete an external account, specifying its name. |
| ExternalAccountsResourceApi | external_account_command_by_name | POST /externalAccounts/account/{name}/commands/{commandName} | Executes a command on the external account specified by name. |
| ExternalAccountsResourceApi | get_supported_categories | GET /externalAccounts/supportedCategories | List of external account categories supported by this Cloudera Manager. |
| ExternalAccountsResourceApi | get_supported_types | GET /externalAccounts/supportedTypes/{categoryName} | List of external account types supported by this Cloudera Manager by category. |
| ExternalAccountsResourceApi | list_external_account_commands | GET /externalAccounts/typeInfo/{typeName}/commandsByName | Lists all the commands that can be executed by name on the provided external account type. |
| ExternalAccountsResourceApi | read_account | GET /externalAccounts/account/{name} | Get a single external account by account name. |
| ExternalAccountsResourceApi | read_account_by_display_name | GET /externalAccounts/accountByDisplayName/{displayName} | Get a single external account by display name. |
| ExternalAccountsResourceApi | read_accounts | GET /externalAccounts/type/{typeName} | Get a list of external accounts for a specific account type. |
| ExternalAccountsResourceApi | read_config | GET /externalAccounts/account/{name}/config | Get configs of external account for the given account name. |
| ExternalAccountsResourceApi | update_account | PUT /externalAccounts/update | Update an external account. |
| ExternalAccountsResourceApi | update_config | PUT /externalAccounts/account/{name}/config | Upadate configs of external account for the given account name. |
| ExternalUserMappingsResourceApi | create_external_user_mappings | POST /externalUserMappings | Creates a list of external user mappings. |
| ExternalUserMappingsResourceApi | delete_external_user_mapping | DELETE /externalUserMappings/{uuid} | Deletes an external user mapping from the system. |
| ExternalUserMappingsResourceApi | read_external_user_mapping | GET /externalUserMappings/{uuid} | Returns detailed information about an external user mapping. |
| ExternalUserMappingsResourceApi | read_external_user_mappings | GET /externalUserMappings | Returns a list of the external user mappings configured in the system. |
| ExternalUserMappingsResourceApi | update_external_user_mapping | PUT /externalUserMappings/{uuid} | Updates the given external user mapping's information. |
| HostTemplatesResourceApi | apply_host_template | POST /clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/applyHostTemplate | Applies a host template to a collection of hosts. |
| HostTemplatesResourceApi | create_host_templates | POST /clusters/{clusterName}/hostTemplates | Creates new host templates. |
| HostTemplatesResourceApi | delete_host_template | DELETE /clusters/{clusterName}/hostTemplates/{hostTemplateName} | Deletes a host template. |
| HostTemplatesResourceApi | read_host_template | GET /clusters/{clusterName}/hostTemplates/{hostTemplateName} | Retrieves information about a host template. |
| HostTemplatesResourceApi | read_host_templates | GET /clusters/{clusterName}/hostTemplates | Lists all host templates in a cluster. |
| HostTemplatesResourceApi | update_host_template | PUT /clusters/{clusterName}/hostTemplates/{hostTemplateName} | Updates an existing host template. |
| HostsResourceApi | create_hosts | POST /hosts | . |
| HostsResourceApi | delete_all_hosts | DELETE /hosts | Delete all hosts in the system. |
| HostsResourceApi | delete_host | DELETE /hosts/{hostId} | Delete a host from the system. |
| HostsResourceApi | enter_maintenance_mode | POST /hosts/{hostId}/commands/enterMaintenanceMode | Put the host into maintenance mode. |
| HostsResourceApi | exit_maintenance_mode | POST /hosts/{hostId}/commands/exitMaintenanceMode | Take the host out of maintenance mode. |
| HostsResourceApi | generate_host_certs | POST /hosts/{hostId}/commands/generateHostCerts | Generates (or regenerates) a key and certificate for this host if Auto-TLS is enabled. |
| HostsResourceApi | get_metrics | GET /hosts/{hostId}/metrics | Fetch metric readings for a host. |
| HostsResourceApi | migrate_roles | POST /hosts/{hostId}/commands/migrateRoles | Migrate roles to a different host. |
| HostsResourceApi | read_host | GET /hosts/{hostId} | Returns a specific Host in the system. |
| HostsResourceApi | read_host_config | GET /hosts/{hostId}/config | Retrieves the configuration of a specific host. |
| HostsResourceApi | read_hosts | GET /hosts | Returns hosts in the system filtered by optional host configuration parameters, if specified. |
| HostsResourceApi | reset_host_id | POST /hosts/{hostId}/commands/resetHostId | Forces agent on specified host to switch to reporting a different host id. |
| HostsResourceApi | update_host | PUT /hosts/{hostId} | . |
| HostsResourceApi | update_host_config | PUT /hosts/{hostId}/config | Updates the host configuration with the given values. |
| ImpalaQueriesResourceApi | cancel_impala_query | POST /clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId}/cancel | Cancels an Impala Query. |
| ImpalaQueriesResourceApi | get_impala_queries | GET /clusters/{clusterName}/services/{serviceName}/impalaQueries | Returns a list of queries that satisfy the filter. |
| ImpalaQueriesResourceApi | get_impala_query_attributes | GET /clusters/{clusterName}/services/{serviceName}/impalaQueries/attributes | Returns the list of all attributes that the Service Monitor can associate with Impala queries. |
| ImpalaQueriesResourceApi | get_query_details | GET /clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId} | Returns details about the query. |
| MgmtRoleCommandsResourceApi | jmap_dump | POST /cm/service/roleCommands/jmapDump | Run the jmapDump diagnostic command. |
| MgmtRoleCommandsResourceApi | jmap_histo | POST /cm/service/roleCommands/jmapHisto | Run the jmapHisto diagnostic command. |
| MgmtRoleCommandsResourceApi | jstack | POST /cm/service/roleCommands/jstack | Run the jstack diagnostic command. |
| MgmtRoleCommandsResourceApi | lsof | POST /cm/service/roleCommands/lsof | Run the lsof diagnostic command. |
| MgmtRoleCommandsResourceApi | restart_command | POST /cm/service/roleCommands/restart | Restart a set of Cloudera Management Services roles. |
| MgmtRoleCommandsResourceApi | start_command | POST /cm/service/roleCommands/start | Start a set of Cloudera Management Services roles. |
| MgmtRoleCommandsResourceApi | stop_command | POST /cm/service/roleCommands/stop | Stop a set of Cloudera Management Services roles. |
| MgmtRoleConfigGroupsResourceApi | read_config | GET /cm/service/roleConfigGroups/{roleConfigGroupName}/config | Returns the current revision of the config for the specified role config group in the Cloudera Management Services. |
| MgmtRoleConfigGroupsResourceApi | read_role_config_group | GET /cm/service/roleConfigGroups/{roleConfigGroupName} | Returns the information for a given role config group in the Cloudera Management Services. |
| MgmtRoleConfigGroupsResourceApi | read_role_config_groups | GET /cm/service/roleConfigGroups | Returns the information for all role config groups in the Cloudera Management Services. |
| MgmtRoleConfigGroupsResourceApi | read_roles | GET /cm/service/roleConfigGroups/{roleConfigGroupName}/roles | Returns all roles in the given role config group in the Cloudera Management Services. |
| MgmtRoleConfigGroupsResourceApi | update_config | PUT /cm/service/roleConfigGroups/{roleConfigGroupName}/config | Updates the config for the given role config group in the Cloudera Management Services. |
| MgmtRoleConfigGroupsResourceApi | update_role_config_group | PUT /cm/service/roleConfigGroups/{roleConfigGroupName} | Updates an existing role config group in the Cloudera Management Services. |
| MgmtRolesResourceApi | create_roles | POST /cm/service/roles | Create new roles in the Cloudera Management Services. |
| MgmtRolesResourceApi | delete_role | DELETE /cm/service/roles/{roleName} | Delete a role from the Cloudera Management Services. |
| MgmtRolesResourceApi | enter_maintenance_mode | POST /cm/service/roles/{roleName}/commands/enterMaintenanceMode | Put the Cloudera Management Service role into maintenance mode. |
| MgmtRolesResourceApi | exit_maintenance_mode | POST /cm/service/roles/{roleName}/commands/exitMaintenanceMode | Take the Cloudera Management Service role out of maintenance mode. |
| MgmtRolesResourceApi | get_full_log | GET /cm/service/roles/{roleName}/logs/full | Retrieves the log file for the role's main process. |
| MgmtRolesResourceApi | get_stacks_log | GET /cm/service/roles/{roleName}/logs/stacks | Retrieves the stacks log file, if any, for the role's main process. |
| MgmtRolesResourceApi | get_stacks_logs_bundle | GET /cm/service/roles/{roleName}/logs/stacksBundle | Download a zip-compressed archive of role stacks logs. |
| MgmtRolesResourceApi | get_standard_error | GET /cm/service/roles/{roleName}/logs/stderr | Retrieves the role's standard error output. |
| MgmtRolesResourceApi | get_standard_output | GET /cm/service/roles/{roleName}/logs/stdout | Retrieves the role's standard output. |
| MgmtRolesResourceApi | list_active_commands | GET /cm/service/roles/{roleName}/commands | List active role commands. |
| MgmtRolesResourceApi | read_role | GET /cm/service/roles/{roleName} | Retrieve detailed information about a Cloudera Management Services role. |
| MgmtRolesResourceApi | read_role_config | GET /cm/service/roles/{roleName}/config | Retrieve the configuration of a specific Cloudera Management Services role. |
| MgmtRolesResourceApi | read_roles | GET /cm/service/roles | List all roles of the Cloudera Management Services. |
| MgmtRolesResourceApi | update_role_config | PUT /cm/service/roles/{roleName}/config | Update the configuration of a Cloudera Management Services role. |
| MgmtServiceResourceApi | auto_assign_roles | PUT /cm/service/autoAssignRoles | Automatically assign roles to hosts and create the roles for the Cloudera Management Service. |
| MgmtServiceResourceApi | auto_configure | PUT /cm/service/autoConfigure | Automatically configures roles of the Cloudera Management Service. |
| MgmtServiceResourceApi | delete_cms | DELETE /cm/service | Delete the Cloudera Management Services. |
| MgmtServiceResourceApi | enter_maintenance_mode | POST /cm/service/commands/enterMaintenanceMode | Put Cloudera Management Service into maintenance mode. |
| MgmtServiceResourceApi | exit_maintenance_mode | POST /cm/service/commands/exitMaintenanceMode | Take Cloudera Management Service out of maintenance mode. |
| MgmtServiceResourceApi | list_active_commands | GET /cm/service/commands | List active Cloudera Management Services commands. |
| MgmtServiceResourceApi | list_role_types | GET /cm/service/roleTypes | List the supported role types for the Cloudera Management Services. |
| MgmtServiceResourceApi | read_service | GET /cm/service | Retrieve information about the Cloudera Management Services. |
| MgmtServiceResourceApi | read_service_config | GET /cm/service/config | Retrieve the configuration of the Cloudera Management Services. |
| MgmtServiceResourceApi | restart_command | POST /cm/service/commands/restart | Restart the Cloudera Management Services. |
| MgmtServiceResourceApi | setup_cms | PUT /cm/service | Setup the Cloudera Management Services. |
| MgmtServiceResourceApi | start_command | POST /cm/service/commands/start | Start the Cloudera Management Services. |
| MgmtServiceResourceApi | stop_command | POST /cm/service/commands/stop | Stop the Cloudera Management Services. |
| MgmtServiceResourceApi | update_service_config | PUT /cm/service/config | Update the Cloudera Management Services configuration. |
| NameservicesResourceApi | get_metrics | GET /clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}/metrics | Fetch metric readings for a particular nameservice. |
| NameservicesResourceApi | list_nameservices | GET /clusters/{clusterName}/services/{serviceName}/nameservices | List the nameservices of an HDFS service. |
| NameservicesResourceApi | read_nameservice | GET /clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice} | Retrieve information about a nameservice. |
| ParcelResourceApi | activate_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/activate | A synchronous command that activates the parcel on the cluster. |
| ParcelResourceApi | cancel_distribution_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDistribution | A synchronous command that cancels the parcel distribution. |
| ParcelResourceApi | cancel_download_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDownload | A synchronous command that cancels the parcel download. |
| ParcelResourceApi | deactivate_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/deactivate | A synchronous command that deactivates the parcel on the cluster. |
| ParcelResourceApi | read_parcel | GET /clusters/{clusterName}/parcels/products/{product}/versions/{version} | Retrieves detailed information about a parcel. |
| ParcelResourceApi | remove_download_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/removeDownload | A synchronous command that removes the downloaded parcel. |
| ParcelResourceApi | start_distribution_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDistribution | A synchronous command that starts the distribution of the parcel to the cluster. |
| ParcelResourceApi | start_download_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDownload | A synchronous command that starts the parcel download. |
| ParcelResourceApi | start_removal_of_distribution_command | POST /clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startRemovalOfDistribution | A synchronous command that removes the distribution from the hosts in the cluster. |
| ParcelsResourceApi | get_parcel_usage | GET /clusters/{clusterName}/parcels/usage | Retrieve details parcel usage information for the cluster. |
| ParcelsResourceApi | read_parcels | GET /clusters/{clusterName}/parcels | Lists all parcels that the cluster has access to. |
| ProcessResourceApi | get_config_file | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/process/configFiles/{configFileName} | Returns the contents of the specified config file. |
| ProcessResourceApi | get_process | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/process | |
| ReplicationsResourceApi | collect_diagnostic_data | POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/collectDiagnosticData | Collect diagnostic data for a schedule, optionally for a subset of commands on that schedule, matched by schedule ID. |
| ReplicationsResourceApi | create_schedules | POST /clusters/{clusterName}/services/{serviceName}/replications | Creates one or more replication schedules. |
| ReplicationsResourceApi | delete_all_schedules | DELETE /clusters/{clusterName}/services/{serviceName}/replications | Deletes all existing replication schedules. |
| ReplicationsResourceApi | delete_schedule | DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} | Deletes an existing replication schedule. |
| ReplicationsResourceApi | get_replication_state | GET /clusters/{clusterName}/services/{serviceName}/replications/replicationState | returns the replication state. |
| ReplicationsResourceApi | read_history | GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/history | Returns a list of commands triggered by a schedule. |
| ReplicationsResourceApi | read_schedule | GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} | Returns information for a specific replication schedule. |
| ReplicationsResourceApi | read_schedules | GET /clusters/{clusterName}/services/{serviceName}/replications | Returns information for all replication schedules. |
| ReplicationsResourceApi | run_copy_listing | POST /clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing | Run the hdfs copy listing command. |
| ReplicationsResourceApi | run_schedule | POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/run | Run the schedule immediately. |
| ReplicationsResourceApi | update_schedule | PUT /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} | Updates an existing replication schedule. |
| RoleCommandsResourceApi | format_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsFormat | Format HDFS NameNodes. |
| RoleCommandsResourceApi | hdfs_bootstrap_stand_by_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsBootstrapStandBy | Bootstrap HDFS stand-by NameNodes. |
| RoleCommandsResourceApi | hdfs_enter_safemode | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsEnterSafemode | Enter safemode for namenodes. |
| RoleCommandsResourceApi | hdfs_finalize_metadata_upgrade | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsFinalizeMetadataUpgrade | Finalize HDFS NameNode metadata upgrade. |
| RoleCommandsResourceApi | hdfs_initialize_auto_failover_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsInitializeAutoFailover | Initialize HDFS HA failover controller metadata. |
| RoleCommandsResourceApi | hdfs_initialize_shared_dir_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsInitializeSharedDir | Initialize HDFS NameNodes' shared edit directory. |
| RoleCommandsResourceApi | hdfs_leave_safemode | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsLeaveSafemode | Leave safemode for namenodes. |
| RoleCommandsResourceApi | hdfs_save_namespace | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsSaveNamespace | Save namespace for namenodes. |
| RoleCommandsResourceApi | jmap_dump | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/jmapDump | Run the jmapDump diagnostic command. |
| RoleCommandsResourceApi | jmap_histo | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/jmapHisto | Run the jmapHisto diagnostic command. |
| RoleCommandsResourceApi | jstack | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/jstack | Run the jstack diagnostic command. |
| RoleCommandsResourceApi | lsof | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/lsof | Run the lsof diagnostic command. |
| RoleCommandsResourceApi | refresh_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/refresh | Refresh a role's data. |
| RoleCommandsResourceApi | restart_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/restart | Restart a set of role instances. |
| RoleCommandsResourceApi | role_command_by_name | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/{commandName} | Execute a role command by name. |
| RoleCommandsResourceApi | start_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/start | Start a set of role instances. |
| RoleCommandsResourceApi | stop_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/stop | Stop a set of role instances. |
| RoleCommandsResourceApi | sync_hue_db_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/hueSyncDb | Create / update the Hue database schema. |
| RoleCommandsResourceApi | zoo_keeper_cleanup_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/zooKeeperCleanup | Cleanup a list of ZooKeeper server roles. |
| RoleCommandsResourceApi | zoo_keeper_init_command | POST /clusters/{clusterName}/services/{serviceName}/roleCommands/zooKeeperInit | Initialize a list of ZooKeeper server roles. |
| RoleConfigGroupsResourceApi | create_role_config_groups | POST /clusters/{clusterName}/services/{serviceName}/roleConfigGroups | Creates new role config groups. |
| RoleConfigGroupsResourceApi | delete_role_config_group | DELETE /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName} | Deletes a role config group. |
| RoleConfigGroupsResourceApi | move_roles | PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/roles | Moves roles to the specified role config group. |
| RoleConfigGroupsResourceApi | move_roles_to_base_group | PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/roles | Moves roles to the base role config group. |
| RoleConfigGroupsResourceApi | read_config | GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/config | Returns the current revision of the config for the specified role config group. |
| RoleConfigGroupsResourceApi | read_role_config_group | GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName} | Returns the information for a role config group. |
| RoleConfigGroupsResourceApi | read_role_config_groups | GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups | Returns the information for all role config groups for a given cluster and service. |
| RoleConfigGroupsResourceApi | read_roles | GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/roles | Returns all roles in the given role config group. |
| RoleConfigGroupsResourceApi | update_config | PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/config | Updates the config for the given role config group. |
| RoleConfigGroupsResourceApi | update_role_config_group | PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName} | Updates an existing role config group. |
| RolesResourceApi | bulk_delete_roles | POST /clusters/{clusterName}/services/{serviceName}/roles/bulkDelete | Bulk delete roles in a particular service by name. |
| RolesResourceApi | create_roles | POST /clusters/{clusterName}/services/{serviceName}/roles | Create new roles in a given service. |
| RolesResourceApi | delete_role | DELETE /clusters/{clusterName}/services/{serviceName}/roles/{roleName} | Deletes a role from a given service. |
| RolesResourceApi | enter_maintenance_mode | POST /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/enterMaintenanceMode | Put the role into maintenance mode. |
| RolesResourceApi | exit_maintenance_mode | POST /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/exitMaintenanceMode | Take the role out of maintenance mode. |
| RolesResourceApi | get_full_log | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/full | Retrieves the log file for the role's main process. |
| RolesResourceApi | get_metrics | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/metrics | Fetch metric readings for a particular role. |
| RolesResourceApi | get_stacks_log | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stacks | Retrieves the stacks log file, if any, for the role's main process. |
| RolesResourceApi | get_stacks_logs_bundle | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stacksBundle | Download a zip-compressed archive of role stacks logs. |
| RolesResourceApi | get_standard_error | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stderr | Retrieves the role's standard error output. |
| RolesResourceApi | get_standard_output | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stdout | Retrieves the role's standard output. |
| RolesResourceApi | impala_diagnostics | POST /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/impalaDiagnostics | Collects diagnostics data for an Impala role. |
| RolesResourceApi | list_active_commands | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands | List active role commands. |
| RolesResourceApi | list_commands | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commandsByName | Lists all the commands that can be executed by name on the provided role. |
| RolesResourceApi | read_role | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName} | Retrieves detailed information about a role. |
| RolesResourceApi | read_role_config | GET /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/config | Retrieves the configuration of a specific role. |
| RolesResourceApi | read_roles | GET /clusters/{clusterName}/services/{serviceName}/roles | Lists all roles of a given service. |
| RolesResourceApi | update_role_config | PUT /clusters/{clusterName}/services/{serviceName}/roles/{roleName}/config | Updates the role configuration with the given values. |
| ServicesResourceApi | collect_yarn_application_diagnostics | POST /clusters/{clusterName}/services/{serviceName}/commands/yarnApplicationDiagnosticsCollection | Collect the Diagnostics data for Yarn applications. |
| ServicesResourceApi | create_beeswax_warehouse_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hueCreateHiveWarehouse | Create the Beeswax role's Hive warehouse directory, on Hue services. |
| ServicesResourceApi | create_h_base_root_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateRoot | Creates the root directory of an HBase service. |
| ServicesResourceApi | create_hive_user_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveUserDir | Create the Hive user directory. |
| ServicesResourceApi | create_hive_warehouse_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouse | Create the Hive warehouse directory, on Hive services. |
| ServicesResourceApi | create_impala_user_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaCreateUserDir | Create the Impala user directory. |
| ServicesResourceApi | create_oozie_db | POST /clusters/{clusterName}/services/{serviceName}/commands/createOozieDb | Creates the Oozie Database Schema in the configured database. |
| ServicesResourceApi | create_services | POST /clusters/{clusterName}/services | Creates a list of services. |
| ServicesResourceApi | create_solr_hdfs_home_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/createSolrHdfsHomeDir | Creates the home directory of a Solr service in HDFS. |
| ServicesResourceApi | create_sqoop_user_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/createSqoopUserDir | Creates the user directory of a Sqoop service in HDFS. |
| ServicesResourceApi | create_yarn_cm_container_usage_input_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/yarnCreateCmContainerUsageInputDirCommand | Creates the HDFS directory where YARN container usage metrics are stored by NodeManagers for CM to read and aggregate into app usage metrics. |
| ServicesResourceApi | create_yarn_job_history_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/yarnCreateJobHistoryDirCommand | Create the Yarn job history directory. |
| ServicesResourceApi | create_yarn_node_manager_remote_app_log_dir_command | POST /clusters/{clusterName}/services/{serviceName}/commands/yarnNodeManagerRemoteAppLogDirCommand | Create the Yarn NodeManager remote application log directory. |
| ServicesResourceApi | decommission_command | POST /clusters/{clusterName}/services/{serviceName}/commands/decommission | Decommission roles of a service. |
| ServicesResourceApi | delete_service | DELETE /clusters/{clusterName}/services/{serviceName} | Deletes a service from the system. |
| ServicesResourceApi | deploy_client_config_command | POST /clusters/{clusterName}/services/{serviceName}/commands/deployClientConfig | Deploy a service's client configuration. |
| ServicesResourceApi | disable_jt_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/disableJtHa | Disable high availability (HA) for JobTracker. |
| ServicesResourceApi | disable_llama_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaHa | Not Supported. |
| ServicesResourceApi | disable_llama_rm_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaRm | Not Supported. |
| ServicesResourceApi | disable_oozie_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/oozieDisableHa | Disable high availability (HA) for Oozie. |
| ServicesResourceApi | disable_rm_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/disableRmHa | Disable high availability (HA) for ResourceManager. |
| ServicesResourceApi | disable_sentry_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/disableSentryHa | Disable high availability (HA) for Sentry service. |
| ServicesResourceApi | enable_jt_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/enableJtHa | Enable high availability (HA) for a JobTracker. |
| ServicesResourceApi | enable_llama_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaHa | Not Supported. |
| ServicesResourceApi | enable_llama_rm_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaRm | Not Supported. |
| ServicesResourceApi | enable_oozie_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/oozieEnableHa | Enable high availability (HA) for Oozie service. |
| ServicesResourceApi | enable_rm_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/enableRmHa | Enable high availability (HA) for a YARN ResourceManager. |
| ServicesResourceApi | enable_sentry_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/enableSentryHa | Enable high availability (HA) for Sentry service. |
| ServicesResourceApi | enter_maintenance_mode | POST /clusters/{clusterName}/services/{serviceName}/commands/enterMaintenanceMode | Put the service into maintenance mode. |
| ServicesResourceApi | exit_maintenance_mode | POST /clusters/{clusterName}/services/{serviceName}/commands/exitMaintenanceMode | Take the service out of maintenance mode. |
| ServicesResourceApi | first_run | POST /clusters/{clusterName}/services/{serviceName}/commands/firstRun | Prepare and start a service. |
| ServicesResourceApi | get_client_config | GET /clusters/{clusterName}/services/{serviceName}/clientConfig | Download a zip-compressed archive of the client configuration, of a specific service. |
| ServicesResourceApi | get_hdfs_usage_report | GET /clusters/{clusterName}/services/{serviceName}/reports/hdfsUsageReport | Fetch the HDFS usage report. |
| ServicesResourceApi | get_impala_utilization | GET /clusters/{clusterName}/services/{serviceName}/impalaUtilization | Provides the resource utilization of the Impala service as well as the resource utilization per tenant. |
| ServicesResourceApi | get_metrics | GET /clusters/{clusterName}/services/{serviceName}/metrics | Fetch metric readings for a particular service. |
| ServicesResourceApi | get_mr_usage_report | GET /clusters/{clusterName}/services/{serviceName}/reports/mrUsageReport | Fetch the MR usage report. |
| ServicesResourceApi | get_yarn_utilization | GET /clusters/{clusterName}/services/{serviceName}/yarnUtilization | Provides the resource utilization of the yarn service as well as the resource utilization per tenant. |
| ServicesResourceApi | hbase_upgrade_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hbaseUpgrade | Upgrade HBase data in HDFS and ZooKeeper as part of upgrade from CDH4 to CDH5. |
| ServicesResourceApi | hdfs_create_tmp_dir | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsCreateTmpDir | Creates a tmp directory on the HDFS filesystem. |
| ServicesResourceApi | hdfs_disable_auto_failover_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableAutoFailover | Disable auto-failover for a highly available HDFS nameservice. |
| ServicesResourceApi | hdfs_disable_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableHa | Disable high availability (HA) for an HDFS NameNode. |
| ServicesResourceApi | hdfs_disable_nn_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableNnHa | Disable High Availability (HA) with Automatic Failover for an HDFS NameNode. |
| ServicesResourceApi | hdfs_enable_auto_failover_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableAutoFailover | Enable auto-failover for an HDFS nameservice. |
| ServicesResourceApi | hdfs_enable_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableHa | Enable high availability (HA) for an HDFS NameNode. |
| ServicesResourceApi | hdfs_enable_nn_ha_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableNnHa | Enable High Availability (HA) with Automatic Failover for an HDFS NameNode. |
| ServicesResourceApi | hdfs_failover_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsFailover | Initiate a failover in an HDFS HA NameNode pair. |
| ServicesResourceApi | hdfs_finalize_rolling_upgrade | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsFinalizeRollingUpgrade | Finalizes the rolling upgrade for HDFS by updating the NameNode metadata permanently to the next version. |
| ServicesResourceApi | hdfs_roll_edits_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsRollEdits | Roll the edits of an HDFS NameNode or Nameservice. |
| ServicesResourceApi | hdfs_upgrade_metadata_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hdfsUpgradeMetadata | Upgrade HDFS Metadata as part of a major version upgrade. |
| ServicesResourceApi | hive_create_metastore_database_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabase | Create the Hive Metastore Database. |
| ServicesResourceApi | hive_create_metastore_database_tables_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabaseTables | Create the Hive Metastore Database tables. |
| ServicesResourceApi | hive_update_metastore_namenodes_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveUpdateMetastoreNamenodes | Update Hive Metastore to point to a NameNode's Nameservice name instead of hostname. |
| ServicesResourceApi | hive_upgrade_metastore_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveUpgradeMetastore | Upgrade Hive Metastore as part of a major version upgrade. |
| ServicesResourceApi | hive_validate_metastore_schema_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hiveValidateMetastoreSchema | Validate the Hive Metastore Schema. |
| ServicesResourceApi | hue_dump_db_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hueDumpDb | Runs Hue's dumpdata command. |
| ServicesResourceApi | hue_load_db_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hueLoadDb | Runs Hue's loaddata command. |
| ServicesResourceApi | hue_sync_db_command | POST /clusters/{clusterName}/services/{serviceName}/commands/hueSyncDb | Runs Hue's syncdb command. |
| ServicesResourceApi | impala_create_catalog_database_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabase | . |
| ServicesResourceApi | impala_create_catalog_database_tables_command | POST /clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabaseTables | . |
| ServicesResourceApi | import_mr_configs_into_yarn | POST /clusters/{clusterName}/services/{serviceName}/commands/importMrConfigsIntoYarn | Import MapReduce configuration into Yarn, overwriting Yarn configuration. |
| ServicesResourceApi | init_solr_command | POST /clusters/{clusterName}/services/{serviceName}/commands/initSolr | Initializes the Solr service in Zookeeper. |
| ServicesResourceApi | install_mr_framework_jars | POST /clusters/{clusterName}/services/{serviceName}/commands/installMrFrameworkJars | Creates an HDFS directory to hold the MapReduce2 framework JARs (if necessary), and uploads the framework JARs to it. |
| ServicesResourceApi | install_oozie_share_lib | POST /clusters/{clusterName}/services/{serviceName}/commands/installOozieShareLib | Creates directory for Oozie user in HDFS and installs the ShareLib in it. |
| ServicesResourceApi | ks_migrate_to_sentry | POST /clusters/{clusterName}/services/{serviceName}/commands/migrateToSentry | Migrates the HBase Indexer policy-based permissions to Sentry, by invoking the SentryConfigToolIndexer. |
| ServicesResourceApi | list_active_commands | GET /clusters/{clusterName}/services/{serviceName}/commands | List active service commands. |
| ServicesResourceApi | list_role_types | GET /clusters/{clusterName}/services/{serviceName}/roleTypes | List the supported role types for a service. |
| ServicesResourceApi | list_service_commands | GET /clusters/{clusterName}/services/{serviceName}/commandsByName | Lists all the commands that can be executed by name on the provided service. |
| ServicesResourceApi | offline_command | POST /clusters/{clusterName}/services/{serviceName}/commands/offline | Offline roles of a service. |
| ServicesResourceApi | oozie_create_embedded_database_command | POST /clusters/{clusterName}/services/{serviceName}/commands/oozieCreateEmbeddedDatabase | Create the Oozie Server Database. |
| ServicesResourceApi | oozie_dump_database_command | POST /clusters/{clusterName}/services/{serviceName}/commands/oozieDumpDatabase | Dump the Oozie Server Database. |
| ServicesResourceApi | oozie_load_database_command | POST /clusters/{clusterName}/services/{serviceName}/commands/oozieLoadDatabase | Load the Oozie Server Database from dump. |
| ServicesResourceApi | oozie_upgrade_db_command | POST /clusters/{clusterName}/services/{serviceName}/commands/oozieUpgradeDb | Upgrade Oozie Database schema as part of a major version upgrade. |
| ServicesResourceApi | read_service | GET /clusters/{clusterName}/services/{serviceName} | Retrieves details information about a service. |
| ServicesResourceApi | read_service_config | GET /clusters/{clusterName}/services/{serviceName}/config | Retrieves the configuration of a specific service. |
| ServicesResourceApi | read_services | GET /clusters/{clusterName}/services | Lists all services registered in the cluster. |
| ServicesResourceApi | recommission_command | POST /clusters/{clusterName}/services/{serviceName}/commands/recommission | Recommission roles of a service. |
| ServicesResourceApi | recommission_with_start_command | POST /clusters/{clusterName}/services/{serviceName}/commands/recommissionWithStart | Start and recommission roles of a service. |
| ServicesResourceApi | restart_command | POST /clusters/{clusterName}/services/{serviceName}/commands/restart | Restart the service. |
| ServicesResourceApi | rolling_restart | POST /clusters/{clusterName}/services/{serviceName}/commands/rollingRestart | Command to run rolling restart of roles in a service. |
| ServicesResourceApi | sentry_create_database_command | POST /clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabase | Create the Sentry Server Database. |
| ServicesResourceApi | sentry_create_database_tables_command | POST /clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabaseTables | Create the Sentry Server Database tables. |
| ServicesResourceApi | sentry_upgrade_database_tables_command | POST /clusters/{clusterName}/services/{serviceName}/commands/sentryUpgradeDatabaseTables | Upgrade the Sentry Server Database tables. |
| ServicesResourceApi | service_command_by_name | POST /clusters/{clusterName}/services/{serviceName}/commands/{commandName} | Executes a command on the service specified by name. |
| ServicesResourceApi | solr_bootstrap_collections_command | POST /clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapCollections | Bootstraps Solr Collections after the CDH upgrade. |
| ServicesResourceApi | solr_bootstrap_config_command | POST /clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapConfig | Bootstraps Solr config during the CDH upgrade. |
| ServicesResourceApi | solr_config_backup_command | POST /clusters/{clusterName}/services/{serviceName}/commands/solrConfigBackup | Backs up Solr configuration metadata before CDH upgrade. |
| ServicesResourceApi | solr_migrate_sentry_privileges_command | POST /clusters/{clusterName}/services/{serviceName}/commands/solrMigrateSentryPrivilegesCommand | Migrates Sentry privileges to new model compatible to support more granular permissions if Solr is configured with a Sentry service. |
| ServicesResourceApi | solr_reinitialize_state_for_upgrade_command | POST /clusters/{clusterName}/services/{serviceName}/commands/solrReinitializeStateForUpgrade | Reinitializes the Solr state by clearing the Solr HDFS data directory, the Solr data directory, and the Zookeeper state. |
| ServicesResourceApi | solr_validate_metadata_command | POST /clusters/{clusterName}/services/{serviceName}/commands/solrValidateMetadata | Validates Solr metadata and configurations. |
| ServicesResourceApi | sqoop_create_database_tables_command | POST /clusters/{clusterName}/services/{serviceName}/commands/sqoopCreateDatabaseTables | Create the Sqoop2 Server Database tables. |
| ServicesResourceApi | sqoop_upgrade_db_command | POST /clusters/{clusterName}/services/{serviceName}/commands/sqoopUpgradeDb | Upgrade Sqoop Database schema as part of a major version upgrade. |
| ServicesResourceApi | start_command | POST /clusters/{clusterName}/services/{serviceName}/commands/start | Start the service. |
| ServicesResourceApi | stop_command | POST /clusters/{clusterName}/services/{serviceName}/commands/stop | Stop the service. |
| ServicesResourceApi | switch_to_mr2 | POST /clusters/{clusterName}/services/{serviceName}/commands/switchToMr2 | Change the cluster to use MR2 instead of MR1. |
| ServicesResourceApi | update_service | PUT /clusters/{clusterName}/services/{serviceName} | Updates service information. |
| ServicesResourceApi | update_service_config | PUT /clusters/{clusterName}/services/{serviceName}/config | Updates the service configuration with the given values. |
| ServicesResourceApi | yarn_format_state_store | POST /clusters/{clusterName}/services/{serviceName}/commands/yarnFormatStateStore | Formats the state store in ZooKeeper used for Resource Manager High Availability. |
| ServicesResourceApi | zoo_keeper_cleanup_command | POST /clusters/{clusterName}/services/{serviceName}/commands/zooKeeperCleanup | Clean up all running server instances of a ZooKeeper service. |
| ServicesResourceApi | zoo_keeper_init_command | POST /clusters/{clusterName}/services/{serviceName}/commands/zooKeeperInit | Initializes all the server instances of a ZooKeeper service. |
| SnapshotsResourceApi | create_policies | POST /clusters/{clusterName}/services/{serviceName}/snapshots/policies | Creates one or more snapshot policies. |
| SnapshotsResourceApi | delete_policy | DELETE /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName} | Deletes an existing snapshot policy. |
| SnapshotsResourceApi | read_history | GET /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}/history | Returns a list of commands triggered by a snapshot policy. |
| SnapshotsResourceApi | read_policies | GET /clusters/{clusterName}/services/{serviceName}/snapshots/policies | Returns information for all snapshot policies. |
| SnapshotsResourceApi | read_policy | GET /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName} | Returns information for a specific snapshot policy. |
| SnapshotsResourceApi | update_policy | PUT /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName} | Updates an existing snapshot policy. |
| TimeSeriesResourceApi | get_entity_type_attributes | GET /timeseries/entityTypeAttributes | Retrieve all metric entity type attributes monitored by Cloudera Manager. |
| TimeSeriesResourceApi | get_entity_types | GET /timeseries/entityTypes | Retrieve all metric entity types monitored by Cloudera Manager. |
| TimeSeriesResourceApi | get_metric_schema | GET /timeseries/schema | Retrieve schema for all metrics. |
| TimeSeriesResourceApi | query_time_series | GET /timeseries | Retrieve time-series data from the Cloudera Manager (CM) time-series data store using a tsquery. |
| TimeSeriesResourceApi | query_time_series_0 | POST /timeseries | Retrieve time-series data from the Cloudera Manager (CM) time-series data store accepting HTTP POST request. |
| ToolsResourceApi | echo | GET /tools/echo | Echoes the provided message back to the caller. |
| ToolsResourceApi | echo_error | GET /tools/echoError | Throws an error containing the given input message. |
| UsersResourceApi | create_users2 | POST /users | Creates a list of users. |
| UsersResourceApi | delete_user2 | DELETE /users/{userName} | Deletes a user from the system. |
| UsersResourceApi | expire_sessions | POST /users/expireSessions/{userName} | Expires the sessions associated with interactive authenticated user in Cloudera Manager. |
| UsersResourceApi | get_sessions | GET /users/sessions | Return a list of the sessions associated with interactive authenticated users in Cloudera Manager. |
| UsersResourceApi | read_user2 | GET /users/{userName} | Returns detailed information about a user. |
| UsersResourceApi | read_users2 | GET /users | Returns a list of the user names configured in the system. |
| UsersResourceApi | update_user2 | PUT /users/{userName} | Updates the given user's information. |
| WatchedDirResourceApi | add_watched_directory | POST /clusters/{clusterName}/services/{serviceName}/watcheddir | Adds a directory to the watching list. |
| WatchedDirResourceApi | list_watched_directories | GET /clusters/{clusterName}/services/{serviceName}/watcheddir | Lists all the watched directories. |
| WatchedDirResourceApi | remove_watched_directory | DELETE /clusters/{clusterName}/services/{serviceName}/watcheddir/{directoryPath} | Removes a directory from the watching list. |
| YarnApplicationsResourceApi | get_yarn_application_attributes | GET /clusters/{clusterName}/services/{serviceName}/yarnApplications/attributes | Returns the list of all attributes that the Service Monitor can associate with YARN applications. |
| YarnApplicationsResourceApi | get_yarn_applications | GET /clusters/{clusterName}/services/{serviceName}/yarnApplications | Returns a list of applications that satisfy the filter. |
| YarnApplicationsResourceApi | kill_yarn_application | POST /clusters/{clusterName}/services/{serviceName}/yarnApplications/{applicationId}/kill | Kills an YARN Application. |