All URIs are relative to https://localhost/api/v31
| Method | HTTP request | Description |
|---|---|---|
| addHosts | POST /clusters/{clusterName}/hosts | |
| autoAssignRoles | PUT /clusters/{clusterName}/autoAssignRoles | Automatically assign roles to hosts and create the roles for all the services in a cluster. |
| autoConfigure | PUT /clusters/{clusterName}/autoConfigure | Automatically configures roles and services in a cluster. |
| configureForKerberos | POST /clusters/{clusterName}/commands/configureForKerberos | Command to configure the cluster to use Kerberos for authentication. |
| createClusters | POST /clusters | Creates a collection of clusters. |
| deleteCluster | DELETE /clusters/{clusterName} | Deletes a cluster. |
| deleteClusterCredentialsCommand | POST /clusters/{clusterName}/commands/deleteCredentials | Delete existing Kerberos credentials for the cluster. |
| deployClientConfig | POST /clusters/{clusterName}/commands/deployClientConfig | Deploy the cluster-wide client configuration. |
| deployClusterClientConfig | POST /clusters/{clusterName}/commands/deployClusterClientConfig | Deploy the Cluster's Kerberos client configuration. |
| enterMaintenanceMode | POST /clusters/{clusterName}/commands/enterMaintenanceMode | Put the cluster into maintenance mode. |
| exitMaintenanceMode | POST /clusters/{clusterName}/commands/exitMaintenanceMode | Take the cluster out of maintenance mode. |
| expireLogs | POST /clusters/{clusterName}/commands/expireLogs | Remove backup and disaster related log files in hdfs. |
| export | GET /clusters/{clusterName}/export | Export the cluster template for the given cluster. |
| firstRun | POST /clusters/{clusterName}/commands/firstRun | Prepare and start services in a cluster. |
| getClientConfig | GET /clusters/{clusterName}/clientConfig | Download a zip-compressed archive of the client configuration, of a specific cluster. |
| getKerberosInfo | GET /clusters/{clusterName}/kerberosInfo | Provides Cluster Kerberos information. |
| getUtilizationReport | GET /clusters/{clusterName}/utilization | Provides the resource utilization of the entire cluster as well as the resource utilization per tenant. |
| inspectHostsCommand | POST /clusters/{clusterName}/commands/inspectHosts | Runs the host inspector on the configured hosts in the specified cluster. |
| listActiveCommands | GET /clusters/{clusterName}/commands | List active cluster commands. |
| listDfsServices | GET /clusters/{clusterName}/dfsServices | List the services that can provide distributed file system (DFS) capabilities in this cluster. |
| listHosts | GET /clusters/{clusterName}/hosts | |
| listServiceTypes | GET /clusters/{clusterName}/serviceTypes | List the supported service types for a cluster. |
| perfInspectorCommand | POST /clusters/{clusterName}/commands/perfInspector | Run cluster performance diagnostics test. |
| poolsRefresh | POST /clusters/{clusterName}/commands/poolsRefresh | Updates all refreshable configuration files for services with Dynamic Resource Pools. |
| preUpgradeCheckCommand | POST /clusters/{clusterName}/commands/preUpgradeCheck | Run cluster pre-upgrade check(s) when upgrading from specified version of CDH to the other. |
| readCluster | GET /clusters/{clusterName} | Reads information about a cluster. |
| readClusters | GET /clusters | Lists all known clusters. |
| refresh | POST /clusters/{clusterName}/commands/refresh | Updates all refreshable configuration files in the cluster. |
| removeAllHosts | DELETE /clusters/{clusterName}/hosts | |
| removeHost | DELETE /clusters/{clusterName}/hosts/{hostId} | |
| restartCommand | POST /clusters/{clusterName}/commands/restart | Restart all services in the cluster. |
| rollingRestart | POST /clusters/{clusterName}/commands/rollingRestart | Command to do a "best-effort" rolling restart of the given cluster, i. |
| rollingUpgrade | POST /clusters/{clusterName}/commands/rollingUpgrade | Command to do a rolling upgrade of specific services in the given cluster This command does not handle any services that don't support rolling upgrades. |
| startCommand | POST /clusters/{clusterName}/commands/start | Start all services in the cluster. |
| stopCommand | POST /clusters/{clusterName}/commands/stop | Stop all services in the cluster. |
| updateCluster | PUT /clusters/{clusterName} | Update an existing cluster. |
| upgradeCdhCommand | POST /clusters/{clusterName}/commands/upgradeCdh | Perform CDH upgrade to the specified version. |
| upgradeServicesCommand | POST /clusters/{clusterName}/commands/upgradeServices | Upgrades the services in the cluster to the CDH5 version. |
ApiHostRefList addHosts(clusterName, body)
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| body | ApiHostRefList | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. |
null (empty response body)
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. |
null (empty response body)
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiConfigureForKerberosArguments | Arguments for the configure for kerberos command. | [optional] |
ApiClusterList createClusters(body)
Creates a collection of clusters.
Creates a collection of clusters.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| body | ApiClusterList | List of clusters to created. | [optional] |
ApiCluster deleteCluster(clusterName)
Deletes a cluster.
Deletes a cluster.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | Name of cluster to delete. |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | cluster name |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster | |
| body | ApiHostRefList | Hosts in cluster to deploy to. If empty, will target all eligible hosts in the cluster. | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster |
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.
// 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
BigDecimal days = new BigDecimal(); // 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster | |
| days | BigDecimal | logs more than these many days old are purged. -2 to use the existing setting | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | cluster name | |
| exportAutoConfig | Boolean | export configs set by the auto configuration | [optional] [default to false] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The cluster name. |
ApiKerberosInfo getKerberosInfo(clusterName)
Provides Cluster Kerberos information.
Provides Cluster Kerberos information
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The cluster name. |
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.
// 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.
Integer endHourOfDay = 23; // Integer | 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.
Integer startHourOfDay = 0; // Integer | 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | cluster name | |
| daysOfWeek | 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. | [optional] |
| endHourOfDay | Integer | 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. | [optional] [default to 23] |
| from | String | Start of the time range to report utilization in ISO 8601 format. | [optional] |
| startHourOfDay | Integer | 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. | [optional] [default to 0] |
| tenantType | String | The type of the tenant (POOL or USER). | [optional] [default to POOL] |
| to | String | End of the the time range to report utilization in ISO 8601 format (defaults to now). | [optional] [default to now] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster |
ApiCommandList listActiveCommands(clusterName, view)
List active cluster commands.
List active cluster commands.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| view | String | The view of the data to materialize, either "summary" or "full". | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | cluster name | |
| view | String | data view required for matching services | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
ApiHostRefList listHosts(clusterName)
// 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.listHosts(clusterName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersResourceApi#listHosts");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String |
ApiServiceTypeList listServiceTypes(clusterName)
List the supported service types for a cluster.
List the supported service types for a cluster.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The cluster. |
ApiCommand perfInspectorCommand(clusterName, body)
Run cluster performance diagnostics test.
Run cluster performance diagnostics test.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiClusterPerfInspectorArgs | Optional arguments for the command. See ApiClusterPerfInspectorArgs. | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster |
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:
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiCdhUpgradeArgs | Arguments for the command. See ApiCdhUpgradeArgs. | [optional] |
ApiCluster readCluster(clusterName)
Reads information about a cluster.
Reads information about a cluster.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | Name of cluster to look up. |
ApiClusterList readClusters(view)
Lists all known clusters.
Lists all known clusters.
// 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 view = "summary"; // String |
try {
ApiClusterList result = apiInstance.readClusters(view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersResourceApi#readClusters");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| view | String | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster |
ApiHostRefList removeAllHosts(clusterName)
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String |
ApiHostRef removeHost(clusterName, hostId)
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| hostId | String |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiRestartClusterArgs | arguments for the restart command. | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiRollingRestartClusterArgs | Arguments for the rolling restart command. | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiRollingUpgradeServicesArgs | Arguments for the rolling upgrade command. | [optional] |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. |
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiCluster | [optional] |
ApiCommand upgradeCdhCommand(clusterName, body)
Perform CDH upgrade to the specified version.
Perform CDH upgrade to the specified version.
Allows the following upgrades:
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.
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. | |
| body | ApiCdhUpgradeArgs | Arguments for the command. See ApiCdhUpgradeArgs. | [optional] |
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:
// 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();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | The name of the cluster. |