Cloudera Manager API (5.13.0)

This is the reference for the Java client to Cloudera Manager (CM).

See:
Description

Packages

com.cloudera.api	This document describes the Cloudera Manager REST API.
com.cloudera.api.model	Java models of the underlying API JSON objects, with JAX-B annotations.
com.cloudera.api.v1	API version 1, introduced in Cloudera Manager 4.0.
com.cloudera.api.v10	API version 10, introduced in Cloudera Manager 5.4.0.
com.cloudera.api.v11	API version 11, introduced in Cloudera Manager 5.5.0.
com.cloudera.api.v12	API version 12, introduced in Cloudera Manager 5.7.0.
com.cloudera.api.v13	API version 13, introduced in Cloudera Manager 5.8.0.
com.cloudera.api.v14	API version 14, introduced in Cloudera Manager 5.9.0.
com.cloudera.api.v15	API version 15, introduced in Cloudera Manager 5.10.0.
com.cloudera.api.v16	API version 16, introduced in Cloudera Manager 5.11.0.
com.cloudera.api.v17	API version 17, introduced in Cloudera Manager 5.12.0.
com.cloudera.api.v18	API version 18, introduced in Cloudera Manager 5.13.0.
com.cloudera.api.v2	API version 2, introduced in Cloudera Manager 4.1.
com.cloudera.api.v3	API version 3, introduced in Cloudera Manager 4.5.
com.cloudera.api.v4	API version 4, introduced in Cloudera Manager 4.6.
com.cloudera.api.v5	API version 5, introduced in Cloudera Manager 4.7.
com.cloudera.api.v6	API version 6, introduced in Cloudera Manager 5.0.0-beta-1.
com.cloudera.api.v7	API version 7, introduced in Cloudera Manager 5.1.0.
com.cloudera.api.v8	API version 8, introduced in Cloudera Manager 5.2.0.
com.cloudera.api.v9	API version 9, introduced in Cloudera Manager 5.3.0.

This is the reference for the Java client to Cloudera Manager (CM).

Getting Started

While the CM API is defined as a RESTful HTTP API, using JSON objects for requests and responses, you rarely need to interact with the HTTP or JSON layer as a user of the Java client. The Java client is a proxy, built from the same JAX-RS interface that defines the server-side implementation.

The main entry point to the Java client is via the ClouderaManagerClientBuilder. For example:

    RootResourceV3 apiRoot = new ClouderaManagerClientBuilder()
        .withHost("your.cm.com")
        .withUsernamePassword("admin", "admin")
        .build()
        .getRootV3();
    

Versions and Compatibility

In the snippet above, the final call to getRootV3() returns a RootResourceV3. Alternatively, a call to getRootV2() would return the v2 equivalent. You should use the version that corresponds to your CM installation, which you can find out by accessing http://your.cm.com:7180/api/version.

Within the same major version of CM, API support is backwards compatible. For example, CM 4.5 introduces API v3, and it also accepts API requests of v1 (CM 4.0) and v2 (CM 4.1).

Error Codes

Upon errors, the client will throw exceptions with HTTP error codes in the 400s and 500s:

• 400 — Invalid request parameters; Malformed requests
• 401 — Authentication failure
• 403 — Authorization failure
• 404 — Object not found
• 500 — Internal API error
• 503 — Response temporarily unavailable; caller should retry later