Cloudera Enterprise 6.0.x | Other versions

Cloudera Manager API

The Cloudera Manager API provides configuration and service lifecycle management, service health information and metrics, and allows you to configure Cloudera Manager itself. The API is served on the same host and port as the Cloudera Manager Admin Console, and does not require an extra process or extra configuration. The API supports HTTP Basic Authentication, accepting the same users and credentials as the Cloudera Manager Admin Console.

Continue reading:

Resources
Backing Up and Restoring the Cloudera Manager Configuration

Resources

Obtaining Configuration Files

Obtain the list of a service's roles:

http://cm_server_host:7180/api/v18/clusters/clusterName/services/serviceName/roles

Obtain the list of configuration files a process is using:

http://cm_server_host:7180/api/v18/clusters/clusterName/services/serviceName/roles/roleName/process

Obtain the content of any particular file:

http://cm_server_host:7180/api/v18/clusters/clusterName/services/serviceName/roles/roleName/process/
configFiles/configFileName

For example:

http://cm_server_host:7180/api/v18/clusters/Cluster%201/services/OOZIE-1/roles/
OOZIE-1-OOZIE_SERVER-e121641328fcb107999f2b5fd856880d/process/configFiles/oozie-site.xml

Retrieving Service and Host Properties

To update a service property using the Cloudera Manager APIs, you'll need to know the name of the property, not just the display name. If you know the property's display name but not the property name itself, retrieve the documentation by requesting any configuration object with the query string view=FULL appended to the URL. For example:

http://cm_server_host:7180/api/v18/clusters/Cluster%201/services/service_name/config?view=FULL

Search the results for the display name of the desired property. For example, a search for the display name HDFS Service Environment Advanced Configuration Snippet (Safety Valve) shows that the corresponding property name is hdfs_service_env_safety_valve:

{
   "name" : "hdfs_service_env_safety_valve",
   "require" : false,
   "displayName" : "HDFS Service Environment Advanced Configuration Snippet (Safety Valve)",
   "description" : "For advanced use onlyu, key/value pairs (one on each line) to be inserted into a roles
   environment. Applies to configurations of all roles in this service except client configuration.",
   "relatedName" : "",
   "validationState" : "OK"
}

Similar to finding service properties, you can also find host properties. First, get the host IDs for a cluster with the URL:

http://cm_server_host:7180/api/v18/hosts

This should return host objects of the form:

{
   "hostId" : "2c2e951c-aaf2-4780-a69f-0382181f1821",
   "ipAddress" : "10.30.195.116",
   "hostname" : "cm_server_host",
   "rackId" : "/default",
   "hostUrl" : "http://cm_server_host:7180/cmf/hostRedirect/2c2e951c-adf2-4780-a69f-0382181f1821",
   "maintenanceMode" : false,
   "maintenanceOwners" : [ ],
   "commissionState" : "COMMISSIONED",
   "numCores" : 4,
   "totalPhysMemBytes" : 10371174400
}

Then obtain the host properties by including one of the returned host IDs in the URL:

http://cm_server_host:7180/api/v18/hosts/2c2e951c-adf2-4780-a69f-0382181f1821?view=FULL

Backing Up and Restoring the Cloudera Manager Configuration

You can use the Cloudera Manager REST API to export and import all of its configuration data. The API exports a JSON document that contains configuration data for the Cloudera Manager instance. You can use this JSON document to back up and restore a Cloudera Manager deployment.

Minimum Required Role: Cluster Administrator (also provided by Full Administrator)

Exporting the Cloudera Manager Configuration

Log in to the Cloudera Manager server host as the root user.
Run the following command:
```
# curl -u admin_uname:admin_pass "http://cm_server_host:7180/api/v18/cm/deployment" >
path_to_file/cm-deployment.json
```
Where:
- admin_uname is a username with either the Full Administrator or Cluster Administrator role.
- admin_pass is the password for the admin_uname username.
- cm_server_host is the hostname of the Cloudera Manager server.
- path_to_file is the path to the file where you want to save the configuration.

Redacting Sensitive Information from the Exported Configuration

The exported configuration may contain passwords and other sensitive information. You can configure redaction of the sensitive items by specifying a JVM parameter for Cloudera Manager. When you set this parameter, API calls to Cloudera Manager for configuration data do not include the sensitive information.

Important: If you configure this redaction, you cannot use an exported configuration to restore the configuration of your cluster due to the redacted information.

To configure redaction for the API:

Log in the Cloudera Manager server host.
Edit the /etc/default/cloudera-scm-server file by adding the following property (separate each property with a space) to the line that begins with export CMF_JAVA_OPTS:
```
-Dcom.cloudera.api.redaction=true
```
For example:
```
export CMF_JAVA_OPTS="-Xmx2G -Dcom.cloudera.api.redaction=true"
```

Restart Cloudera Manager:

$ sudo service cloudera-scm-server restart

Restoring the Cloudera Manager Configuration

Important: This feature requires a Cloudera Enterprise license. It is not available in Cloudera Express. See Managing Licenses for more information.

Using a previously saved JSON document that contains the Cloudera Manager configuration data, you can restore that configuration to a running cluster.

Using the Cloudera Manager Administration Console, stop all running services in your cluster:
1. On the Home > Status tab, click to the right of the cluster name and select Stop.
2. Click Stop in the confirmation screen. The Command Details window shows the progress of stopping services.
  When All services successfully stopped appears, the task is complete and you can close the Command Details window.
Warning: If you do not stop the cluster before making this API call, the API call will stop all cluster services before running the job. Any running jobs and data are lost.
Log in to the Cloudera Manager server host as the root user.
Run the following command:
```
# curl --upload-file path_to_file/cm-deployment.json
-u admin_uname:admin_pass http://cm_server_host:7180/api/v18/cm/deployment?deleteCurrentDeployment=true
```
Where:
- admin_uname is a username with either the Full Administrator or Cluster Administrator role.
- admin_pass is the password for the admin_uname username.
- cm_server_host is the hostname of the Cloudera Manager server.
- path_to_file is the path to the file containing the JSON configuration file.

Page generated July 25, 2018.