ClouderaManagerResourceApi

All URIs are relative to https://localhost/api/v46

addCustomCerts

ApiCommand addCustomCerts(body)

Add custom certificates to the Auto-TLS certificate database.

Add custom certificates to the Auto-TLS certificate database

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiAddCustomCertsArguments body = new ApiAddCustomCertsArguments(); // ApiAddCustomCertsArguments | 
try {
    ApiCommand result = apiInstance.addCustomCerts(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#addCustomCerts");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

beginTrial

beginTrial()

Begin trial license.

Begin trial license.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    apiInstance.beginTrial();
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#beginTrial");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

clustersPerfInspectorCommand

ApiCommand clustersPerfInspectorCommand(body)

Run performance diagnostics test against specified clusters in ApiClustersPerfInspectorArgs User must be Full Administrator or Global Cluster Administrator.

Run performance diagnostics test against specified clusters in ApiClustersPerfInspectorArgs User must be Full Administrator or Global Cluster Administrator.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiClustersPerfInspectorArgs body = new ApiClustersPerfInspectorArgs(); // ApiClustersPerfInspectorArgs | Required arguments for the command. See ApiClustersPerfInspectorArgs.
try {
    ApiCommand result = apiInstance.clustersPerfInspectorCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#clustersPerfInspectorCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

collectDiagnosticDataCommand

ApiCommand collectDiagnosticDataCommand(body)

Collect diagnostic data from hosts managed by Cloudera Manager.

Collect diagnostic data from hosts managed by Cloudera Manager.

After the command has completed, the ApiCommand will contain a resultDataUrl from where you can download the result.

Only available with Cloudera Manager Enterprise Edition.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiCollectDiagnosticDataArguments body = new ApiCollectDiagnosticDataArguments(); // ApiCollectDiagnosticDataArguments | The command arguments.
try {
    ApiCommand result = apiInstance.collectDiagnosticDataCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#collectDiagnosticDataCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteCredentialsCommand

ApiCommand deleteCredentialsCommand(deleteCredentialsMode)

Delete existing Kerberos credentials.

Delete existing Kerberos credentials.

This command will affect all services that have been configured to use Kerberos, and have existing credentials. In V18 this takes a new paramater to determine whether it needs to delete all credentials or just unused ones.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String deleteCredentialsMode = "all"; // String | this can be set to \"all\" or \"unused\"
try {
    ApiCommand result = apiInstance.deleteCredentialsCommand(deleteCredentialsMode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#deleteCredentialsCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

endTrial

endTrial()

End trial license.

End trial license.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    apiInstance.endTrial();
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#endTrial");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

generateCmca

ApiCommand generateCmca(body)

Generate a CMCA.

Generate a CMCA

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiGenerateCmcaArguments body = new ApiGenerateCmcaArguments(); // ApiGenerateCmcaArguments | 
try {
    ApiCommand result = apiInstance.generateCmca(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#generateCmca");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

generateCredentialsAdhoc

ApiCommand generateCredentialsAdhoc(body)

Generate missing Kerberos credentials, optionally accepting a list of ad-hoc credentials to generate as well.

Generate missing Kerberos credentials, optionally accepting a list of ad-hoc credentials to generate as well.

This command will affect all services that have been configured to use Kerberos, and haven't had their credentials generated yet.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiPrincipalList body = new ApiPrincipalList(); // ApiPrincipalList | 
try {
    ApiCommand result = apiInstance.generateCredentialsAdhoc(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#generateCredentialsAdhoc");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

generateCredentialsCommand

ApiCommand generateCredentialsCommand()

Generate missing Kerberos credentials.

Generate missing Kerberos credentials.

This command will affect all services that have been configured to use Kerberos, and haven't had their credentials generated yet.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiCommand result = apiInstance.generateCredentialsCommand();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#generateCredentialsCommand");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getConfig

ApiConfigList getConfig(view)

Retrieve the Cloudera Manager settings.

Retrieve the Cloudera Manager settings.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String view = "summary"; // String | The view to materialize, either \"summary\" or \"full\".
try {
    ApiConfigList result = apiInstance.getConfig(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getConfig");
    e.printStackTrace();
}

Parameters

Return type

ApiConfigList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getDeployment2

ApiDeployment2 getDeployment2(view)

Retrieve full description of the entire Cloudera Manager deployment including all hosts, clusters, services, roles, users, settings, etc.

Retrieve full description of the entire Cloudera Manager deployment including all hosts, clusters, services, roles, users, settings, etc.

This object can be used to reconstruct your entire deployment

Note: Only users with sufficient privileges are allowed to call this.

• Full Administrators
• Cluster Administrators (but Navigator config will be redacted)

Note: starting with v19, the deployment information contains a newer version of users ApiUser2 that can hold granular permissions.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String view = "export"; // String | May be one of \"export\" (default) or \"export_redacted\".  The latter replaces configurations that are sensitive with the word \"REDACTED\". Other filter options are not supported.
try {
    ApiDeployment2 result = apiInstance.getDeployment2(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getDeployment2");
    e.printStackTrace();
}

Parameters

Return type

ApiDeployment2

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getKerberosInfo

ApiKerberosInfo getKerberosInfo()

Provides Cloudera Manager Kerberos information.

Provides Cloudera Manager Kerberos information

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiKerberosInfo result = apiInstance.getKerberosInfo();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getKerberosInfo");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiKerberosInfo

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getKerberosPrincipals

ApiPrincipalList getKerberosPrincipals(missingOnly)

Returns the Kerberos principals needed by the services being managed by Cloudera Manager.

Returns the Kerberos principals needed by the services being managed by Cloudera Manager.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
Boolean missingOnly = true; // Boolean | Whether to include only those principals which do not already exist in Cloudera Manager's database.
try {
    ApiPrincipalList result = apiInstance.getKerberosPrincipals(missingOnly);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getKerberosPrincipals");
    e.printStackTrace();
}

Parameters

Return type

ApiPrincipalList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getKrb5Conf

File getKrb5Conf()

Retrieves krb5.

Retrieves krb5.conf of the CM server host

Available since API v41.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    File result = apiInstance.getKrb5Conf();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getKrb5Conf");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

File

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream

getLicensedFeatureUsage

ApiLicensedFeatureUsage getLicensedFeatureUsage()

Retrieve a summary of licensed feature usage.

Retrieve a summary of licensed feature usage.

This command will return information about what Cloudera Enterprise licensed features are in use in the clusters being managed by this Cloudera Manager, as well as totals for usage across all clusters.

The specific features described can vary between different versions of Cloudera Manager.

Available since API v6.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiLicensedFeatureUsage result = apiInstance.getLicensedFeatureUsage();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getLicensedFeatureUsage");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiLicensedFeatureUsage

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLog

String getLog()

Returns the entire contents of the Cloudera Manager log file.

Returns the entire contents of the Cloudera Manager log file

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    String result = apiInstance.getLog();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getLog");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

getScmDbInfo

ApiScmDbInfo getScmDbInfo()

Provides Cloudera Manager server's database information.

Provides Cloudera Manager server's database information

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiScmDbInfo result = apiInstance.getScmDbInfo();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getScmDbInfo");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiScmDbInfo

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getShutdownReadiness

ApiShutdownReadiness getShutdownReadiness(lastActivityTime)

Retrieve Cloudera Manager's readiness for shutdown and destroy.

Retrieve Cloudera Manager's readiness for shutdown and destroy. Applications that wish to destroy Cloudera Manager and its managed cluster should poll this API, repeatedly if necessary, to respect its readiness.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String lastActivityTime = "lastActivityTime_example"; // String | End time of the last known activity/workload against the managed clusters, in ISO 8601 format.
try {
    ApiShutdownReadiness result = apiInstance.getShutdownReadiness(lastActivityTime);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getShutdownReadiness");
    e.printStackTrace();
}

Parameters

Return type

ApiShutdownReadiness

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getVersion

ApiVersionInfo getVersion()

Provides version information of Cloudera Manager itself.

Provides version information of Cloudera Manager itself.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiVersionInfo result = apiInstance.getVersion();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#getVersion");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiVersionInfo

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

hostInstallCommand

ApiCommand hostInstallCommand(body)

Perform installation on a set of hosts.

Perform installation on a set of hosts.

This command installs Cloudera Manager Agent on a set of hosts.

Available since API v6.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiHostInstallArguments body = new ApiHostInstallArguments(); // ApiHostInstallArguments | Hosts to perform installation on
try {
    ApiCommand result = apiInstance.hostInstallCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostInstallCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsDecommissionCommand

ApiCommand hostsDecommissionCommand(body)

Decommission the given hosts.

Decommission the given hosts. All slave roles on the hosts will be decommissioned. All other roles will be stopped.

To offline by Upgrade Domain, use the “upgradeDomains” endpoint from the clusters resource to get the list of host names that belong in each Upgrade Domain. Available since API v40.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiHostNameList body = new ApiHostNameList(); // ApiHostNameList | 
try {
    ApiCommand result = apiInstance.hostsDecommissionCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsDecommissionCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsOfflineOrDecommissionCommand

ApiCommand hostsOfflineOrDecommissionCommand(offlineTimeout, body)

Decommission the given hosts.

Decommission the given hosts. All slave roles on the hosts will be offlined or decommissioned with preference being offlined if supported by the service.

Currently the offline operation is only supported by HDFS, where the offline operation will put DataNodes into HDFS IN MAINTENANCE state which prevents unnecessary re-replication which could occur if decommissioned.

All other roles on the hosts will be stopped.

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

To offline or decommission by Upgrade Domain, use the “upgradeDomains” endpoint from the clusters resource to get the list of host names that belong in each Upgrade Domain. Available since API v40.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
java.math.BigDecimal offlineTimeout = new java.math.BigDecimal(); // java.math.BigDecimal | offline timeout in seconds. Specify as null to get the default timeout (4 hours). Ignored if service does not support he offline operation.
ApiHostNameList body = new ApiHostNameList(); // ApiHostNameList | list of host names to decommission.
try {
    ApiCommand result = apiInstance.hostsOfflineOrDecommissionCommand(offlineTimeout, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsOfflineOrDecommissionCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsPerfInspectorCommand

ApiCommand hostsPerfInspectorCommand(body)

Run performance diagnostics test against specified hosts in ApiHostsPerfInspectorArgs User must be Full Administrator or Global Cluster Administrator.

Run performance diagnostics test against specified hosts in ApiHostsPerfInspectorArgs User must be Full Administrator or Global Cluster Administrator.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiHostsPerfInspectorArgs body = new ApiHostsPerfInspectorArgs(); // ApiHostsPerfInspectorArgs | Required arguments for the command. See ApiHostsPerfInspectorArgs.
try {
    ApiCommand result = apiInstance.hostsPerfInspectorCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsPerfInspectorCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsRecommissionAndExitMaintenanceModeCommand

ApiCommand hostsRecommissionAndExitMaintenanceModeCommand(recommissionType, body)

Recommission and exit maintenance on the given hosts.

Recommission and exit maintenance on the given hosts. The recommission step may optionally start roles as well.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String recommissionType = "recommission"; // String | 
ApiHostNameList body = new ApiHostNameList(); // ApiHostNameList | 
try {
    ApiCommand result = apiInstance.hostsRecommissionAndExitMaintenanceModeCommand(recommissionType, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsRecommissionAndExitMaintenanceModeCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsRecommissionCommand

ApiCommand hostsRecommissionCommand(body)

Recommission the given hosts.

Recommission the given hosts. All slave roles on the hosts will be recommissioned. Roles are not started after this command. Use hostsStartRoles command for that.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiHostNameList body = new ApiHostNameList(); // ApiHostNameList | 
try {
    ApiCommand result = apiInstance.hostsRecommissionCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsRecommissionCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsRecommissionWithStartCommand

ApiCommand hostsRecommissionWithStartCommand(body)

Recommission the given hosts.

Recommission the given hosts. If slave roles support start when decommissioned, start those roles before recommission. All slave roles on the hosts will be recommissioned. Warning: Evolving. This method may change in the future and does not offer standard compatibility guarantees. Recommission the given hosts. If possible, start those roles before recommission. All slave roles on the hosts will be recommissioned. Do not use without guidance from Cloudera. Currently, only HDFS DataNodes will be started by this command.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiHostNameList body = new ApiHostNameList(); // ApiHostNameList | 
try {
    ApiCommand result = apiInstance.hostsRecommissionWithStartCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsRecommissionWithStartCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

hostsStartRolesCommand

ApiCommand hostsStartRolesCommand(body)

Start all the roles on the given hosts.

Start all the roles on the given hosts.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiHostNameList body = new ApiHostNameList(); // ApiHostNameList | 
try {
    ApiCommand result = apiInstance.hostsStartRolesCommand(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#hostsStartRolesCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

importAdminCredentials

ApiCommand importAdminCredentials(password, username)

Imports the KDC Account Manager credentials needed by Cloudera Manager to create kerberos principals needed by CDH services.

Imports the KDC Account Manager credentials needed by Cloudera Manager to create kerberos principals needed by CDH services.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String password = "password_example"; // String | Password for the Account Manager.  return Information about the submitted command.
String username = "username_example"; // String | Username of the Account Manager. Full name including the Kerberos realm must be specified.
try {
    ApiCommand result = apiInstance.importAdminCredentials(password, username);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#importAdminCredentials");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

importClusterTemplate

ApiCommand importClusterTemplate(addRepositories, body)

Create cluster as per the given cluster template.

Create cluster as per the given cluster template

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
Boolean addRepositories = false; // Boolean | if true the parcels repositories in the cluster template will be added.
ApiClusterTemplate body = new ApiClusterTemplate(); // ApiClusterTemplate | cluster template
try {
    ApiCommand result = apiInstance.importClusterTemplate(addRepositories, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#importClusterTemplate");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

importKerberosPrincipal

ApiCommand importKerberosPrincipal(kvno, password, principal)

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.

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
java.math.BigDecimal kvno = new java.math.BigDecimal(); // java.math.BigDecimal | Key-version number of the password.  return Information about the submitted command.
String password = "password_example"; // String | Password for the Kerberos principal. Cloudera Manager will encrypt the principal and password and use it when needed for a daemon.
String principal = "principal_example"; // String | Name of the principal. Full name including the Kerberos realm must be specified. If it already exists, it will be overwritten.
try {
    ApiCommand result = apiInstance.importKerberosPrincipal(kvno, password, principal);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#importKerberosPrincipal");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

inspectHostsCommand

ApiCommand inspectHostsCommand()

Runs the host inspector on the configured hosts.

Runs the host inspector on the configured hosts.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiCommand result = apiInstance.inspectHostsCommand();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#inspectHostsCommand");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listActiveCommands

ApiCommandList listActiveCommands(view)

List active global commands.

List active global commands.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String view = "summary"; // String | The view of the data to materialize, either \"summary\" or \"full\".
try {
    ApiCommandList result = apiInstance.listActiveCommands(view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#listActiveCommands");
    e.printStackTrace();
}

Parameters

Return type

ApiCommandList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

migrateCmcaToDb

ApiCommand migrateCmcaToDb()

Migrate CMCA to the DB.

Migrate CMCA to the DB

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiCommand result = apiInstance.migrateCmcaToDb();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#migrateCmcaToDb");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

readInstance

ApiCmServer readInstance(cmServerId)

Retrieves the CM server information.

Retrieves the CM server information.

Available since API v41.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String cmServerId = "cmServerId_example"; // String | The CM server ID.
try {
    ApiCmServer result = apiInstance.readInstance(cmServerId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#readInstance");
    e.printStackTrace();
}

Parameters

Return type

ApiCmServer

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

readInstances

ApiCmServerList readInstances()

Retrieves all CM server information.

Retrieves all CM server information.

Available since API v41.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiCmServerList result = apiInstance.readInstances();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#readInstances");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCmServerList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

readLicense

ApiLicense readLicense()

Retrieve information about the Cloudera Manager license.

Retrieve information about the Cloudera Manager license.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiLicense result = apiInstance.readLicense();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#readLicense");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiLicense

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

refreshParcelRepos

ApiCommand refreshParcelRepos()

.

Submit a command to refresh parcels information.

This API could be used following two scenarios.
- User updated Cloudera Manager's local parcel repository.
- User updated remote parcel locations.

User wants to invoke this API to make sure that Cloudera Manager gets latest parcels information. User can then monitor the returned command before proceeding to the next step.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
try {
    ApiCommand result = apiInstance.refreshParcelRepos();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#refreshParcelRepos");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

retrieveKeytab

File retrieveKeytab(body)

Retrieves a keytab for a list of principals.

Retrieves a keytab for a list of principals. The principals must already exist.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiPrincipalList body = new ApiPrincipalList(); // ApiPrincipalList | 
try {
    File result = apiInstance.retrieveKeytab(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#retrieveKeytab");
    e.printStackTrace();
}

Parameters

Return type

File

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/octet-stream

testExternalAuthentication

ApiCommand testExternalAuthentication(body)

Launches a command to test the currently configured external authentication.

Launches a command to test the currently configured external authentication

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiTestCmExternalAuthArguments body = new ApiTestCmExternalAuthArguments(); // ApiTestCmExternalAuthArguments | 
try {
    ApiCommand result = apiInstance.testExternalAuthentication(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#testExternalAuthentication");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateConfig

ApiConfigList updateConfig(message, body)

Update the Cloudera Manager settings.

Update the Cloudera Manager settings.

If a value is set in the given configuration, it will be added to the manager's settings, replacing any existing entry. If a value is unset (its value is null), the existing the setting will be erased.

Settings that are not listed in the input will maintain their current values.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
String message = "message_example"; // String | Optional message describing the changes.
ApiConfigList body = new ApiConfigList(); // ApiConfigList | Settings to update.
try {
    ApiConfigList result = apiInstance.updateConfig(message, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#updateConfig");
    e.printStackTrace();
}

Parameters

Return type

ApiConfigList

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateDeployment2

ApiDeployment2 updateDeployment2(deleteCurrentDeployment, body)

Apply the supplied deployment description to the system.

Apply the supplied deployment description to the system. This will create the clusters, services, hosts and other objects specified in the argument. This call does not allow for any merge conflicts. If an entity already exists in the system, this call will fail. You can request, however, that all entities in the system are deleted before instantiating the new ones.

You may specify a complete or partial deployment, e.g. you can provide host info with no clusters. However, if you request that the current deployment be deleted, you are required to specify at least one admin user or this call will fail. This is to protect you from creating a system that cannot be logged into again.

If there are any errors creating (or optionally deleting) a deployment, all changes will be rolled back leaving the system exactly as it was before calling this method. The system will never be left in a state where part of the deployment is created and other parts are not.

If the submitted deployment contains entities that require Cloudera Enterprise license, then the license should be provided to Cloudera Manager before making this API call.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
Boolean deleteCurrentDeployment = false; // Boolean | If true, the current deployment is deleted before the specified deployment is applied
ApiDeployment2 body = new ApiDeployment2(); // ApiDeployment2 | The deployment to create
try {
    ApiDeployment2 result = apiInstance.updateDeployment2(deleteCurrentDeployment, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#updateDeployment2");
    e.printStackTrace();
}

Parameters

Return type

ApiDeployment2

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateGlobalTruststore

ApiCommand updateGlobalTruststore(body)

Add/remove certificates to the Auto-TLS certificate truststore.

Add/remove certificates to the Auto-TLS certificate truststore

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
ApiUpdateGlobalTruststoreArguments body = new ApiUpdateGlobalTruststoreArguments(); // ApiUpdateGlobalTruststoreArguments | 
try {
    ApiCommand result = apiInstance.updateGlobalTruststore(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#updateGlobalTruststore");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateLicense

ApiLicense updateLicense(license)

Updates the Cloudera Manager license.

Updates the Cloudera Manager license.

After a new license is installed, the Cloudera Manager needs to be restarted for the changes to take effect.

The license file should be uploaded using a request with content type "multipart/form-data", instead of being encoded into a JSON representation.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ClouderaManagerResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ClouderaManagerResourceApi apiInstance = new ClouderaManagerResourceApi();
File license = new File("/path/to/file.txt"); // File | 
try {
    ApiLicense result = apiInstance.updateLicense(license);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClouderaManagerResourceApi#updateLicense");
    e.printStackTrace();
}

Parameters

Return type

ApiLicense

Authorization

basic

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json