ClustersResourceApi

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

addHosts

ApiHostRefList addHosts(clusterName, body)

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | 
ApiHostRefList body = new ApiHostRefList(); // ApiHostRefList | 
try {
    ApiHostRefList result = apiInstance.addHosts(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#addHosts");
    e.printStackTrace();
}

Parameters

Return type

ApiHostRefList

Authorization

basic

HTTP request headers

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

addTags

List<ApiEntityTag> addTags(clusterName, body)

Attach tags to the cluster.

Attach tags to the cluster. Tag names beginning with the prefix cldr (case insensitive) are reserved for internal use by Cloudera.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | Name of the cluster
List<ApiEntityTag> body = Arrays.asList(new ApiEntityTag()); // List<ApiEntityTag> | list of tags to add
try {
    List<ApiEntityTag> result = apiInstance.addTags(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#addTags");
    e.printStackTrace();
}

Parameters

Return type

List<ApiEntityTag>

Authorization

basic

HTTP request headers

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

autoAssignRoles

autoAssignRoles(clusterName)

Automatically assign roles to hosts and create the roles for all the services in a cluster.

Automatically assign roles to hosts and create the roles for all the services in a cluster.

Assignments are done based on services and hosts in the cluster, and hardware specifications. If no hosts are added to the cluster, an exception will be thrown preventing any role assignments. Existing roles will be taken into account and their assignments will be not be modified.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    apiInstance.autoAssignRoles(clusterName);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#autoAssignRoles");
    e.printStackTrace();
}

Parameters

Return type

null (empty response body)

Authorization

basic

HTTP request headers

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

autoConfigure

autoConfigure(clusterName)

Automatically configures roles and services in a cluster.

Automatically configures roles and services in a cluster.

Overwrites some existing configurations. Might create new role config groups. Only default role config groups must exist before calling this endpoint. Other role config groups must not exist. If they do, an exception will be thrown preventing any configuration. Ignores the Cloudera Management Service even if colocated with roles of this cluster. To avoid over-committing the heap on hosts, assign hosts to this cluster that are not being used by the Cloudera Management Service.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    apiInstance.autoConfigure(clusterName);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#autoConfigure");
    e.printStackTrace();
}

Parameters

Return type

null (empty response body)

Authorization

basic

HTTP request headers

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

configureAutoTlsServicesCommand

ApiCommand configureAutoTlsServicesCommand(clusterName)

Configures all services in a cluster to use Auto-TLS.

Configures all services in a cluster to use Auto-TLS

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiCommand result = apiInstance.configureAutoTlsServicesCommand(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#configureAutoTlsServicesCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

configureForKerberos

ApiCommand configureForKerberos(clusterName, body)

Command to configure the cluster to use Kerberos for authentication.

Command to configure the cluster to use Kerberos for authentication. This command will configure all relevant services on a cluster for Kerberos usage. This command will trigger a GenerateCredentials command to create Kerberos keytabs for all roles in the cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiConfigureForKerberosArguments body = new ApiConfigureForKerberosArguments(); // ApiConfigureForKerberosArguments | Arguments for the configure for kerberos command.
try {
    ApiCommand result = apiInstance.configureForKerberos(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#configureForKerberos");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

createClusters

ApiClusterList createClusters(body)

Creates a collection of clusters.

Creates a collection of clusters.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
ApiClusterList body = new ApiClusterList(); // ApiClusterList | List of clusters to created.
try {
    ApiClusterList result = apiInstance.createClusters(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#createClusters");
    e.printStackTrace();
}

Parameters

Return type

ApiClusterList

Authorization

basic

HTTP request headers

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

deleteCluster

ApiCluster deleteCluster(clusterName)

Deletes a cluster.

Deletes a cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | Name of cluster to delete.
try {
    ApiCluster result = apiInstance.deleteCluster(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#deleteCluster");
    e.printStackTrace();
}

Parameters

Return type

ApiCluster

Authorization

basic

HTTP request headers

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

deleteClusterCredentialsCommand

ApiCommand deleteClusterCredentialsCommand(clusterName)

Delete existing Kerberos credentials for the cluster.

Delete existing Kerberos credentials for the cluster.

This command will affect all services that have been configured to use Kerberos, and have existing credentials.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | cluster name
try {
    ApiCommand result = apiInstance.deleteClusterCredentialsCommand(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#deleteClusterCredentialsCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

deleteTags

List<ApiEntityTag> deleteTags(clusterName, body)

Remove the tags associated with the cluster.

Remove the tags associated with the cluster. Tag names beginning with the prefix cldr (case insensitive) are reserved for internal use by Cloudera.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | Name of the cluster to remove tags from
List<ApiEntityTag> body = Arrays.asList(new ApiEntityTag()); // List<ApiEntityTag> | 
try {
    List<ApiEntityTag> result = apiInstance.deleteTags(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#deleteTags");
    e.printStackTrace();
}

Parameters

Return type

List<ApiEntityTag>

Authorization

basic

HTTP request headers

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

deployClientConfig

ApiCommand deployClientConfig(clusterName)

Deploy the cluster-wide client configuration.

Deploy the cluster-wide client configuration.

For each service in the cluster, deploy the service's client configuration to all the hosts that the service runs on.

Available since API v2.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.deployClientConfig(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#deployClientConfig");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

deployClientConfigsAndRefresh

ApiCommand deployClientConfigsAndRefresh(clusterName)

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.

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.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiCommand result = apiInstance.deployClientConfigsAndRefresh(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#deployClientConfigsAndRefresh");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

deployClusterClientConfig

ApiCommand deployClusterClientConfig(clusterName, body)

Deploy the Cluster's Kerberos client configuration.

Deploy the Cluster's Kerberos client configuration.

Deploy krb5.conf to hosts in a cluster. Does not deploy to decommissioned hosts or hosts with active processes.

Available since API v7.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
ApiHostRefList body = new ApiHostRefList(); // ApiHostRefList | Hosts in cluster to deploy to. If empty, will target all eligible hosts in the cluster.
try {
    ApiCommand result = apiInstance.deployClusterClientConfig(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#deployClusterClientConfig");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

disableTls

ApiCommand disableTls(clusterName)

Disables TLS settings on a cluster.

Disables TLS settings on a cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.disableTls(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#disableTls");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

enterMaintenanceMode

ApiCommand enterMaintenanceMode(clusterName)

Put the cluster into maintenance mode.

Put the cluster into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.enterMaintenanceMode(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#enterMaintenanceMode");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

exitMaintenanceMode

ApiCommand exitMaintenanceMode(clusterName)

Take the cluster out of maintenance mode.

Take the cluster out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.exitMaintenanceMode(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#exitMaintenanceMode");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

expireLogs

ApiCommand expireLogs(clusterName, days)

Remove backup and disaster related log files in hdfs.

Remove backup and disaster related log files in hdfs.

Available since API v31.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
java.math.BigDecimal days = new java.math.BigDecimal(); // java.math.BigDecimal | logs more than these many days old are purged. -2 to use the existing setting
try {
    ApiCommand result = apiInstance.expireLogs(clusterName, days);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#expireLogs");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

export

ApiClusterTemplate export(clusterName, exportAutoConfig)

Export the cluster template for the given cluster.

Export the cluster template for the given cluster. If cluster does not have host templates defined it will export host templates based on roles assignment.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | cluster name
Boolean exportAutoConfig = false; // Boolean | export configs set by the auto configuration
try {
    ApiClusterTemplate result = apiInstance.export(clusterName, exportAutoConfig);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#export");
    e.printStackTrace();
}

Parameters

Return type

ApiClusterTemplate

Authorization

basic

HTTP request headers

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

firstRun

ApiCommand firstRun(clusterName)

Prepare and start services in a cluster.

Prepare and start services in a cluster.

Perform all the steps needed to prepare each service in a cluster and start the services in order.

Available since API v7.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiCommand result = apiInstance.firstRun(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#firstRun");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

getClientConfig

File getClientConfig(clusterName)

Download a zip-compressed archive of the client configuration, of a specific cluster.

Download a zip-compressed archive of the client configuration, of a specific cluster. Currently, this only includes Kerberos Client Configuration (krb5.conf). For client configuration of services, use the clientConfig endpoint of the services resource. This resource does not require any 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The cluster name.
try {
    File result = apiInstance.getClientConfig(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#getClientConfig");
    e.printStackTrace();
}

Parameters

Return type

File

Authorization

basic

HTTP request headers

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

getKerberosInfo

ApiKerberosInfo getKerberosInfo(clusterName)

Provides Cluster Kerberos information.

Provides Cluster 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The cluster name.
try {
    ApiKerberosInfo result = apiInstance.getKerberosInfo(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#getKerberosInfo");
    e.printStackTrace();
}

Parameters

Return type

ApiKerberosInfo

Authorization

basic

HTTP request headers

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

getOzoneS3GatewayInfo

ApiOzoneS3GatewayInfo getOzoneS3GatewayInfo(clusterName, bucketName)

Returns the REST url for the Ozone S3 Gateway, as well as the AWS credentials needed to access the S3 endpoint.

Returns the REST url for the Ozone S3 Gateway, as well as the AWS credentials needed to access the S3 endpoint. Additionally, creates a bucket with the specified name under the volume s3v. If no Ozone is present, or Ozone is not running, returns success with an empty response. Currently, we get the credentials for the Hive kerberos principal, and give ownership of the created bucket to the same. This is likely not a permanent solution. If the cluster is not kerberizied, we return dummy credentials. Requires CDH 7.2.1+ or CDH 7.1.3+

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
String bucketName = "bucketName_example"; // String | the name of the bucket to create
try {
    ApiOzoneS3GatewayInfo result = apiInstance.getOzoneS3GatewayInfo(clusterName, bucketName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#getOzoneS3GatewayInfo");
    e.printStackTrace();
}

Parameters

Return type

ApiOzoneS3GatewayInfo

Authorization

basic

HTTP request headers

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

getUtilizationReport

ApiClusterUtilization getUtilizationReport(clusterName, daysOfWeek, endHourOfDay, from, startHourOfDay, tenantType, to)

Provides the resource utilization of the entire cluster as well as the resource utilization per tenant.

Provides the resource utilization of the entire cluster as well as the resource utilization per tenant. 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | cluster name
List<String> daysOfWeek = Arrays.asList("daysOfWeek_example"); // List<String> | The days of the week for which the user wants to report utilization. Days is a list of number between 1 to 7, where 1 corresponds to Monday, and 7 corrensponds to Sunday. All 7 days are included if this is not specified.
java.math.BigDecimal endHourOfDay = new java.math.BigDecimal(); // java.math.BigDecimal | The end hour of a day for which the user wants to report utilization. The hour is a number between [0-23]. Default value is 23 if this is not specified.
String from = "from_example"; // String | Start of the time range to report utilization in ISO 8601 format.
java.math.BigDecimal startHourOfDay = new java.math.BigDecimal(); // java.math.BigDecimal | The start hour of a day for which the user wants to report utilization. The hour is a number between [0-23]. Default value is 0 if this is not specified.
String tenantType = "POOL"; // String | The type of the tenant (POOL or USER).
String to = "now"; // String | End of the the time range to report utilization in ISO 8601 format (defaults to now).
try {
    ApiClusterUtilization result = apiInstance.getUtilizationReport(clusterName, daysOfWeek, endHourOfDay, from, startHourOfDay, tenantType, to);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#getUtilizationReport");
    e.printStackTrace();
}

Parameters

Return type

ApiClusterUtilization

Authorization

basic

HTTP request headers

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

inspectHostsCommand

ApiCommand inspectHostsCommand(clusterName)

Runs the host inspector on the configured hosts in the specified cluster.

Runs the host inspector on the configured hosts in the specified cluster. Available since V8.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.inspectHostsCommand(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#inspectHostsCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

isTlsEnabled

Boolean isTlsEnabled(clusterName)

Returns whether a cluster has any TLS settings enabled.

Returns whether a cluster has any TLS settings enabled. This only checks settings that would have been enabled by Auto-TLS.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    Boolean result = apiInstance.isTlsEnabled(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#isTlsEnabled");
    e.printStackTrace();
}

Parameters

Return type

Boolean

Authorization

basic

HTTP request headers

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

listActiveCommands

ApiCommandList listActiveCommands(clusterName, view)

List active cluster commands.

List active cluster 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Return type

ApiCommandList

Authorization

basic

HTTP request headers

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

listDfsServices

ApiServiceList listDfsServices(clusterName, view)

List the services that can provide distributed file system (DFS) capabilities in this cluster.

List the services that can provide distributed file system (DFS) capabilities in this cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | cluster name
String view = "summary"; // String | data view required for matching services
try {
    ApiServiceList result = apiInstance.listDfsServices(clusterName, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#listDfsServices");
    e.printStackTrace();
}

Parameters

Return type

ApiServiceList

Authorization

basic

HTTP request headers

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

listHosts

ApiHostList listHosts(clusterName, configName, configValue, view)

Returns hosts in the system filtered by optional host configuration parameters, if specified.

Returns hosts in the system filtered by optional host configuration parameters, if specified.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | Name of the cluster
String configName = "configName_example"; // String | optional host config name to filter hosts by. Available from v40.
String configValue = "configValue_example"; // String | host config value associated with config name. Available from v40.
String view = "summary"; // String | The view to materialize
try {
    ApiHostList result = apiInstance.listHosts(clusterName, configName, configValue, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#listHosts");
    e.printStackTrace();
}

Parameters

Return type

ApiHostList

Authorization

basic

HTTP request headers

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

listServiceTypes

ApiServiceTypeList listServiceTypes(clusterName)

List the supported service types for a cluster.

List the supported service types for a cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The cluster.
try {
    ApiServiceTypeList result = apiInstance.listServiceTypes(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#listServiceTypes");
    e.printStackTrace();
}

Parameters

Return type

ApiServiceTypeList

Authorization

basic

HTTP request headers

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

listUpgradeDomains

ApiHdfsUpgradeDomainList listUpgradeDomains(clusterName)

Returns the Upgrade Domains associated with the cluster and the host names that belong to each Upgrade Domain.

Returns the Upgrade Domains associated with the cluster and the host names that belong to each Upgrade Domain. Hosts without an Upgrade Domain set will default to using the rack assignment of the host.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiHdfsUpgradeDomainList result = apiInstance.listUpgradeDomains(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#listUpgradeDomains");
    e.printStackTrace();
}

Parameters

Return type

ApiHdfsUpgradeDomainList

Authorization

basic

HTTP request headers

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

perfInspectorCommand

ApiCommand perfInspectorCommand(clusterName, body)

Run cluster performance diagnostics test.

Run cluster performance diagnostics test.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiClusterPerfInspectorArgs body = new ApiClusterPerfInspectorArgs(); // ApiClusterPerfInspectorArgs | Optional arguments for the command. See ApiClusterPerfInspectorArgs.
try {
    ApiCommand result = apiInstance.perfInspectorCommand(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#perfInspectorCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

poolsRefresh

ApiCommand poolsRefresh(clusterName)

Updates all refreshable configuration files for services with Dynamic Resource Pools.

Updates all refreshable configuration files for services with Dynamic Resource Pools.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.poolsRefresh(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#poolsRefresh");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

postClouderaRuntimeUpgrade

ApiCommand postClouderaRuntimeUpgrade(clusterName)

Post Cloudera Runtime upgrade API.

Post Cloudera Runtime upgrade API.

This API executes special finalization tasks (already part of regular CDH upgrade) after the installation of an updated build of Cloudera Runtime (no version change). No version change of Cloudera Rumtime means when first 3 digits of build remains the same (e.g. from 7.2.1.a to 7.2.1.b) during upgrade. Purpose of this is to automate manual tasks of CDH upgrade.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | 
try {
    ApiCommand result = apiInstance.postClouderaRuntimeUpgrade(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#postClouderaRuntimeUpgrade");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

preUpgradeCheckCommand

ApiCommand preUpgradeCheckCommand(clusterName, body)

Run cluster pre-upgrade check(s) when upgrading from specified version of CDH to the other.

Run cluster pre-upgrade check(s) when upgrading from specified version of CDH to the other.

Allows the following upgrade checks:

• Minor upgrades from any CDH 5 to any CDH 5
• Major upgrades from any CDH 5 to any CDH 6
• Minor upgrades from any CDH 6 to any CDH 6
• Maintenance upgrades or downgrades (a.b.x to a.b.y)

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiCdhUpgradeArgs body = new ApiCdhUpgradeArgs(); // ApiCdhUpgradeArgs | Arguments for the command. See ApiCdhUpgradeArgs.
try {
    ApiCommand result = apiInstance.preUpgradeCheckCommand(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#preUpgradeCheckCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

readCluster

ApiCluster readCluster(clusterName)

Reads information about a cluster.

Reads information about a cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | Name of cluster to look up.
try {
    ApiCluster result = apiInstance.readCluster(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#readCluster");
    e.printStackTrace();
}

Parameters

Return type

ApiCluster

Authorization

basic

HTTP request headers

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

readClusters

ApiClusterList readClusters(clusterType, view)

List all known clusters.

List all known clusters.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterType = "base"; // String | Type of cluster, either \"any\", \"base\", \"compute\" or \"experience\". Default is \"base\".
String view = "summary"; // String | The view of the data to materialize, either \"summary\" or \"full\".
try {
    ApiClusterList result = apiInstance.readClusters(clusterType, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#readClusters");
    e.printStackTrace();
}

Parameters

Return type

ApiClusterList

Authorization

basic

HTTP request headers

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

readTags

List<ApiEntityTag> readTags(clusterName, limit, offset)

Returns the tags associated with this cluster.

Returns the tags associated with this cluster. Tag names beginning with the prefix cldr (case insensitive) are reserved for internal use by Cloudera.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
java.math.BigDecimal limit = new java.math.BigDecimal(); // java.math.BigDecimal | Number of tags
java.math.BigDecimal offset = new java.math.BigDecimal(); // java.math.BigDecimal | Index of the first tag to retrieve
try {
    List<ApiEntityTag> result = apiInstance.readTags(clusterName, limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#readTags");
    e.printStackTrace();
}

Parameters

Return type

List<ApiEntityTag>

Authorization

basic

HTTP request headers

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

refresh

ApiCommand refresh(clusterName)

Updates all refreshable configuration files in the cluster.

Updates all refreshable configuration files in the cluster. Will not restart any roles.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster
try {
    ApiCommand result = apiInstance.refresh(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#refresh");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

removeAllHosts

ApiHostRefList removeAllHosts(clusterName)

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | 
try {
    ApiHostRefList result = apiInstance.removeAllHosts(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#removeAllHosts");
    e.printStackTrace();
}

Parameters

Return type

ApiHostRefList

Authorization

basic

HTTP request headers

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

removeHost

ApiHostRef removeHost(clusterName, hostId)

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | 
String hostId = "hostId_example"; // String | 
try {
    ApiHostRef result = apiInstance.removeHost(clusterName, hostId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#removeHost");
    e.printStackTrace();
}

Parameters

Return type

ApiHostRef

Authorization

basic

HTTP request headers

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

restartCommand

ApiCommand restartCommand(clusterName, body)

Restart all services in the cluster.

Restart all services in the cluster.

Services are stopped then started in the appropriate order given their dependencies. The command can optionally restart only stale services and their dependencies as well as redeploy client configuration on all services in the cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiRestartClusterArgs body = new ApiRestartClusterArgs(); // ApiRestartClusterArgs | arguments for the restart command.
try {
    ApiCommand result = apiInstance.restartCommand(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#restartCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

rollingRestart

ApiCommand rollingRestart(clusterName, body)

Command to do a "best-effort" rolling restart of the given cluster, i.

Command to do a "best-effort" rolling restart of the given cluster, i.e. it does plain restart of services that cannot be rolling restarted, followed by first rolling restarting non-slaves and then rolling restarting the slave roles of services that can be rolling restarted. The slave restarts are done host-by-host.

Available since API v4. 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiRollingRestartClusterArgs body = new ApiRollingRestartClusterArgs(); // ApiRollingRestartClusterArgs | Arguments for the rolling restart command.
try {
    ApiCommand result = apiInstance.rollingRestart(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#rollingRestart");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

rollingUpgrade

ApiCommand rollingUpgrade(clusterName, body)

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.

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. The command will throw an error and not start if upgrade of any such service is requested. This command does not upgrade the full CDH Cluster. You should normally use the upgradeCDH Command for upgrading the cluster. This is primarily helpful if you need to need to recover from an upgrade failure or for advanced users to script an alternative to the upgradeCdhCommand. This command expects the binaries to be available on hosts and activated. It does not change any binaries on the 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiRollingUpgradeServicesArgs body = new ApiRollingUpgradeServicesArgs(); // ApiRollingUpgradeServicesArgs | Arguments for the rolling upgrade command.
try {
    ApiCommand result = apiInstance.rollingUpgrade(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#rollingUpgrade");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

startCommand

ApiCommand startCommand(clusterName)

Start all services in the cluster.

Start all services in the cluster.

Services are started in the appropriate order given their dependencies.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiCommand result = apiInstance.startCommand(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#startCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

stopCommand

ApiCommand stopCommand(clusterName)

Stop all services in the cluster.

Stop all services in the cluster.

Services are stopped in the appropriate order given their dependencies.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiCommand result = apiInstance.stopCommand(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#stopCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

tearDownWorkloadCluster

ApiCommand tearDownWorkloadCluster(clusterName, workloadClusterName)

Tear Down Workload cluster.

Tear Down Workload cluster.

Tear Down Ranger plugin service (repository) associated with the workload cluster.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
String workloadClusterName = "workloadClusterName_example"; // String | The name of the workload cluster.
try {
    ApiCommand result = apiInstance.tearDownWorkloadCluster(clusterName, workloadClusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#tearDownWorkloadCluster");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

updateCluster

ApiCluster updateCluster(clusterName, body)

Update an existing cluster.

Update an existing cluster.

To update the CDH version, provide the new value in the "fullVersion" property. Setting a correct version that matches the actual installed software will ensure the correct version-specific features, such as services, roles, commands, and configurations. This need not be manually set for clusters using parcels. In general this action is only necessary after the CDH packages have been manually updated. Note that a downgrade may be rejected if it would render existing services or roles unusable. For major upgrade, the "upgradeService" cluster command should be used instead.

To rename the cluster, provide the new name in the "displayName" property for API >= 6, or in the "name" property for API <=5.

Available since API v2.

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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiCluster body = new ApiCluster(); // ApiCluster | 
try {
    ApiCluster result = apiInstance.updateCluster(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#updateCluster");
    e.printStackTrace();
}

Parameters

Return type

ApiCluster

Authorization

basic

HTTP request headers

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

upgradeCdhCommand

ApiCommand upgradeCdhCommand(clusterName, body)

Perform CDH upgrade to the specified version.

Perform CDH upgrade to the specified version.

Allows the following upgrades:

• Major upgrades from any CDH 4 to any CDH 5
• Minor upgrades from any CDH 5 to any CDH 5
• Maintenance upgrades or downgrades (a.b.x to a.b.y)

If using packages, CDH packages on all hosts of the cluster must be manually upgraded before this command is issued.

The command will upgrade the services and their configuration to the version available in the CDH5 distribution.

Unless rolling upgrade options are provided, the entire cluster will experience downtime. If rolling upgrade options are provided, command will do a "best-effort" rolling upgrade of the given cluster, i.e. it does plain upgrade of services that cannot be rolling upgraded, followed by first rolling upgrading non-slaves and then rolling restarting the slave roles of services that can be rolling restarted. The slave restarts are done host-by-host.

Available since v9. Rolling upgrade is only available with Cloudera Manager Enterprise Edition. A more limited upgrade variant available since 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
ApiCdhUpgradeArgs body = new ApiCdhUpgradeArgs(); // ApiCdhUpgradeArgs | Arguments for the command. See ApiCdhUpgradeArgs.
try {
    ApiCommand result = apiInstance.upgradeCdhCommand(clusterName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#upgradeCdhCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

upgradeServicesCommand

ApiCommand upgradeServicesCommand(clusterName)

Upgrades the services in the cluster to the CDH5 version.

Upgrades the services in the cluster to the CDH5 version.

This command requires that the CDH packages in the hosts used by the cluster be upgraded to CDH5 before this command is issued. Once issued, this command will stop all running services before proceeding.

If parcels are used instead of CDH system packages then the following steps need to happen in order:

1. Stop all services manually
2. Activate parcel
3. Run this upgrade 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.ClustersResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ClustersResourceApi apiInstance = new ClustersResourceApi();
String clusterName = "clusterName_example"; // String | The name of the cluster.
try {
    ApiCommand result = apiInstance.upgradeServicesCommand(clusterName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ClustersResourceApi#upgradeServicesCommand");
    e.printStackTrace();
}

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

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