All URIs are relative to https://localhost/api/v55
| Method | HTTP request | Description |
|---|---|---|
| addHBaseReplicationPeer | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/addReplicationPeer | Starts a command that adds a new replication peer to HBase. |
| addTablesToHBasePeer | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/addTablesToHBasePeer | Starts a command that adds tables and column families to an existing HBase replication peer. |
| checkHBaseTablesExist | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/checkTables | Starts a command that checks if the specified tables exist in HBase. |
| collectDiagnosticData | POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/collectDiagnosticData | Collect diagnostic data for a schedule, optionally for a subset of commands on that schedule, matched by schedule ID. |
| createCloudCredstoreOnHdfs | POST /clusters/{clusterName}/services/{serviceName}/replications/createCloudCredstoreOnHdfs | Creates a credstore provider jceks file on HDFS for the given service. |
| createCredstore | POST /clusters/{clusterName}/services/{serviceName}/replications/createCredstore | Use the following API endpoint instead:. |
| createSchedules | POST /clusters/{clusterName}/services/{serviceName}/replications | Creates one or more replication schedules. |
| deleteAllSchedules | DELETE /clusters/{clusterName}/services/{serviceName}/replications | Deletes all existing replication schedules. |
| deleteSchedule | DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} | Deletes an existing replication schedule. |
| exportRangerServices | POST /clusters/{clusterName}/services/{serviceName}/replications/exportRangerServices | Exports the given Ranger services and policies (defined in the API body) to a zipped file. |
| fetchHBaseColumnFamilies | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/fetchColumnFamilies | Starts a command that fetches column families for the desired tables. |
| fetchHBasePeerInfo | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/fetchHBasePeerInfo | Starts a command that fetches information about an HBase peer by its ID. |
| forceDeleteSchedule | DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/forcedDelete | Deletes an existing replication schedule only from the DB. |
| generateCloudReplCredstorePassword | POST /clusters/{clusterName}/services/{serviceName}/replications/generateCloudReplCredstorePassword | (Re)generates the cloud credential provider password, used by the given service, for replicating to the cloud. |
| getReplicationState | GET /clusters/{clusterName}/services/{serviceName}/replications/replicationState | returns the replication state. |
| isHive3ReverseDirectionEnabled | GET /clusters/{clusterName}/services/{serviceName}/replications/isHive3ReverseDirectionEnabled | This API endpoint checks if there is an ENABLED Hive3 replication policy on this server that replicates for the reverse direction. |
| listHBaseNamespaces | GET /clusters/{clusterName}/services/{serviceName}/replications/operations/listNamespaces | Starts a command that lists all namespaces in HBase. |
| listHBasePeers | GET /clusters/{clusterName}/services/{serviceName}/replications/operations/listPeers | Starts a command that retrieves all peers registered in the HBase service. |
| listHBaseTables | GET /clusters/{clusterName}/services/{serviceName}/replications/operations/listTables | Starts a command that lists tables from the HBase service. |
| readHistory | GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/history | Returns a list of commands triggered by a schedule. |
| readSchedule | GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} | Returns information for a specific replication schedule. |
| readSchedules | GET /clusters/{clusterName}/services/{serviceName}/replications | Retrieves information about replication schedules. |
| recreateCloudCredstoresOnHdfs | POST /clusters/{clusterName}/services/{serviceName}/replications/recreateCloudCredstoresOnHdfs | Recreates the existing credential provider jceks files on HDFS, that are used by the given service, for replicating to the cloud. |
| removeHBasePeer | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/removeHBasePeer | Starts a command that removes the specified HBase replication peer from the local HBase service. |
| removeTablesFromHBasePeer | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/removeTablesFromHBasePeer | Starts a command that removes tables and column families from an existing HBase replication peer. |
| rescheduleHive3ReplicationMetricsGetter | POST /clusters/{clusterName}/services/{serviceName}/replications/rescheduleHive3ReplicationMetricsGetter | Set the Hive3 Replication Metrics Getter next start time. |
| runCopyListing | POST /clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing | Run the hdfs copy listing command. |
| runHBaseReplicationRetryFailedSnapshots | POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/runHBaseReplicationRetryFailedSnapshots | Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID. |
| runHBaseReplicationSecurityTool | POST /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationSecurityTool | Run the hbase replication security tool. |
| runHBaseReplicationValidationTool | POST /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationValidationTool | Executes a command, which validates if HBase replication works properly for the given hbasePeerId. |
| runHiveReplicationQuery | POST /clusters/{clusterName}/services/{serviceName}/replications/hiveReplicationQuery | Execute a hive replication query on local HS2 service instance. |
| runSchedule | POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/run | Run the schedule immediately. |
| setCFsReplicationScope | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/setCFsReplicationScope | Starts a command that set the replication scope of the provided column families to the desired value. |
| updateHBasePeerState | PUT /clusters/{clusterName}/services/{serviceName}/replications/updateHBasePeerState | Update HBase peer state ('DISABLE' or 'ENABLE'),. |
| updateHBaseReplicationPeerState | POST /clusters/{clusterName}/services/{serviceName}/replications/operations/updateReplicationPeerState | Starts a command that updates the state of an existing HBase replication peer. |
| updateSchedule | PUT /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} | Updates an existing replication schedule. |
ApiCommand addHBaseReplicationPeer(clusterName, serviceName, body)
Starts a command that adds a new replication peer to HBase.
Starts a command that adds a new replication peer to HBase.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBaseAddReplicationPeerInput body = new ApiHBaseAddReplicationPeerInput(); // ApiHBaseAddReplicationPeerInput | Information for peer creation.
try {
ApiCommand result = apiInstance.addHBaseReplicationPeer(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#addHBaseReplicationPeer");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBaseAddReplicationPeerInput | Information for peer creation. | [optional] |
ApiCommand addTablesToHBasePeer(clusterName, serviceName, body)
Starts a command that adds tables and column families to an existing HBase replication peer.
Starts a command that adds tables and column families to an existing HBase replication peer.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBasePeerIdWithTableCFs body = new ApiHBasePeerIdWithTableCFs(); // ApiHBasePeerIdWithTableCFs | Arguments for the operation.
try {
ApiCommand result = apiInstance.addTablesToHBasePeer(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#addTablesToHBasePeer");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBasePeerIdWithTableCFs | Arguments for the operation. | [optional] |
ApiCommand checkHBaseTablesExist(clusterName, serviceName, body)
Starts a command that checks if the specified tables exist in HBase.
Starts a command that checks if the specified tables exist in HBase.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBaseTableNames body = new ApiHBaseTableNames(); // ApiHBaseTableNames | Names of the tables to be checked.
try {
ApiCommand result = apiInstance.checkHBaseTablesExist(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#checkHBaseTablesExist");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBaseTableNames | Names of the tables to be checked. | [optional] |
ApiCommand collectDiagnosticData(clusterName, scheduleId, serviceName, view, body)
Collect diagnostic data for a schedule, optionally for a subset of commands on that schedule, matched by schedule ID.
Collect diagnostic data for a schedule, optionally for a subset of commands on that schedule, matched by schedule ID. The returned command's resultDataUrl property, upon the commands completion, will refer to the generated diagnostic data. Available since API v11.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | Schedule ID
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | view to materialize
ApiReplicationDiagnosticsCollectionArgs body = new ApiReplicationDiagnosticsCollectionArgs(); // ApiReplicationDiagnosticsCollectionArgs | Replication collection arguments
try {
ApiCommand result = apiInstance.collectDiagnosticData(clusterName, scheduleId, serviceName, view, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#collectDiagnosticData");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | Schedule ID | |
| serviceName | String | The service name. | |
| view | String | view to materialize | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
| body | ApiReplicationDiagnosticsCollectionArgs | Replication collection arguments | [optional] |
ApiCommand createCloudCredstoreOnHdfs(clusterName, serviceName, force, sourceAccount)
Creates a credstore provider jceks file on HDFS for the given service.
Creates a credstore provider jceks file on HDFS for the given service. The file will store credential information for the given sourceAccount.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
Boolean force = true; // Boolean | if the jceks file already exists on HDFS and this parameter is set to true then it will be recreated, otherwise left untouched
String sourceAccount = "sourceAccount_example"; // String | the External Account that has been already added to this CM, for which the credstore provider jceks file will be generated
try {
ApiCommand result = apiInstance.createCloudCredstoreOnHdfs(clusterName, serviceName, force, sourceAccount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#createCloudCredstoreOnHdfs");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| force | Boolean | if the jceks file already exists on HDFS and this parameter is set to true then it will be recreated, otherwise left untouched | [optional] |
| sourceAccount | String | the External Account that has been already added to this CM, for which the credstore provider jceks file will be generated | [optional] |
ApiCommand createCredstore(clusterName, serviceName, credstoreDirPath, force, sourceAccount)
Use the following API endpoint instead:.
Use the following API endpoint instead: com.cloudera.api.v50.ReplicationsResourceV50#createCloudCredstoreOnHdfs(String, boolean)
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String credstoreDirPath = "credstoreDirPath_example"; // String |
Boolean force = true; // Boolean |
String sourceAccount = "sourceAccount_example"; // String |
try {
ApiCommand result = apiInstance.createCredstore(clusterName, serviceName, credstoreDirPath, force, sourceAccount);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#createCredstore");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| credstoreDirPath | String | [optional] | |
| force | Boolean | [optional] | |
| sourceAccount | String | [optional] |
ApiReplicationScheduleList createSchedules(clusterName, serviceName, body)
Creates one or more replication schedules.
Creates one or more replication schedules.
Available since API v3. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiReplicationScheduleList body = new ApiReplicationScheduleList(); // ApiReplicationScheduleList | List of the replication schedules to create.
try {
ApiReplicationScheduleList result = apiInstance.createSchedules(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#createSchedules");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiReplicationScheduleList | List of the replication schedules to create. | [optional] |
ApiReplicationScheduleList deleteAllSchedules(clusterName, serviceName)
Deletes all existing replication schedules.
Deletes all existing replication schedules.
Available since API v3. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiReplicationScheduleList result = apiInstance.deleteAllSchedules(clusterName, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#deleteAllSchedules");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. |
ApiReplicationSchedule deleteSchedule(clusterName, scheduleId, serviceName)
Deletes an existing replication schedule.
Deletes an existing replication schedule.
Available since API v3. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiReplicationSchedule result = apiInstance.deleteSchedule(clusterName, scheduleId, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#deleteSchedule");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | Id of an existing replication schedule. | |
| serviceName | String | The service name. |
ApiCommand exportRangerServices(clusterName, serviceName, body)
Exports the given Ranger services and policies (defined in the API body) to a zipped file.
Exports the given Ranger services and policies (defined in the API body) to a zipped file.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiRangerReplicationExportArgs body = new ApiRangerReplicationExportArgs(); // ApiRangerReplicationExportArgs | the arguments for the export operation. Contains the Ranger services to be exported.
try {
ApiCommand result = apiInstance.exportRangerServices(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#exportRangerServices");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiRangerReplicationExportArgs | the arguments for the export operation. Contains the Ranger services to be exported. | [optional] |
ApiCommand fetchHBaseColumnFamilies(clusterName, serviceName, whereReplicationSet, body)
Starts a command that fetches column families for the desired tables.
Starts a command that fetches column families for the desired tables.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
Boolean whereReplicationSet = false; // Boolean | Whether to retrieve column families of only those tables where there is at least one column family with replication scope set to 1.
ApiHBaseTableNames body = new ApiHBaseTableNames(); // ApiHBaseTableNames | Names of tables to query for column families.
try {
ApiCommand result = apiInstance.fetchHBaseColumnFamilies(clusterName, serviceName, whereReplicationSet, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#fetchHBaseColumnFamilies");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| whereReplicationSet | Boolean | Whether to retrieve column families of only those tables where there is at least one column family with replication scope set to 1. | [optional] [default to false] |
| body | ApiHBaseTableNames | Names of tables to query for column families. | [optional] |
ApiCommand fetchHBasePeerInfo(clusterName, serviceName, body)
Starts a command that fetches information about an HBase peer by its ID.
Starts a command that fetches information about an HBase peer by its ID.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBasePeerId body = new ApiHBasePeerId(); // ApiHBasePeerId | ID of the fetched peer.
try {
ApiCommand result = apiInstance.fetchHBasePeerInfo(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#fetchHBasePeerInfo");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBasePeerId | ID of the fetched peer. | [optional] |
ApiReplicationSchedule forceDeleteSchedule(clusterName, scheduleId, serviceName)
Deletes an existing replication schedule only from the DB.
Deletes an existing replication schedule only from the DB.
Only the DB schedule reference is deleted with no further cleanup on the source or target side. Typically this endpoint can be used when the source cluster is not available any more and normal policy delete fails during cleanup. Available since API v46. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiReplicationSchedule result = apiInstance.forceDeleteSchedule(clusterName, scheduleId, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#forceDeleteSchedule");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | Id of an existing replication schedule. | |
| serviceName | String | The service name. |
Boolean generateCloudReplCredstorePassword(clusterName, serviceName, passwordGenerateMode)
(Re)generates the cloud credential provider password, used by the given service, for replicating to the cloud.
(Re)generates the cloud credential provider password, used by the given service, for replicating to the cloud.
Calling this API endpoint may cause staleness for the given service.
NOTE: If this API endpoint REGENERATED the credstore password successfully and there are existing credstore provider jceks files on HDFS, protected by this password, then these jceks files should be recreated by using the following API endpoint: #recreateCloudCredstoresOnHdfs().
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String passwordGenerateMode = "passwordGenerateMode_example"; // String | the CloudReplPasswordGenerateMode to be used for regenerating the password.
try {
Boolean result = apiInstance.generateCloudReplCredstorePassword(clusterName, serviceName, passwordGenerateMode);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#generateCloudReplCredstorePassword");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| passwordGenerateMode | String | the CloudReplPasswordGenerateMode to be used for regenerating the password. | [optional] [enum: FORCE, GENERATE_IF_NULL, REGENERATE_IF_SET] |
Boolean
ApiReplicationState getReplicationState(clusterName, serviceName, view)
returns the replication state.
returns the replication state. for example if incremental export is enabled, etc
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | view to materialize
try {
ApiReplicationState result = apiInstance.getReplicationState(clusterName, serviceName, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#getReplicationState");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| view | String | view to materialize | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
Boolean isHive3ReverseDirectionEnabled(clusterName, serviceName, clusterUuidOnRemote, serviceNameOnRemote, sourceDbNameOnRemote, targetDbNameOnRemote)
This API endpoint checks if there is an ENABLED Hive3 replication policy on this server that replicates for the reverse direction.
This API endpoint checks if there is an ENABLED Hive3 replication policy on this server that replicates for the reverse direction. Bidirectional Hive3 replication policies are allowed, but only one direction can be ENABLED at the same time.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String clusterUuidOnRemote = "clusterUuidOnRemote_example"; // String | the uuid of the cluster on the remote CM server
String serviceNameOnRemote = "serviceNameOnRemote_example"; // String | the Hive3 service name on the remote CM server, more specifically on the cluster specified by clusterUuidOnRemote
String sourceDbNameOnRemote = "sourceDbNameOnRemote_example"; // String | the name of the source database on the remote CM server
String targetDbNameOnRemote = "targetDbNameOnRemote_example"; // String | the name of the target database on the remote CM server
try {
Boolean result = apiInstance.isHive3ReverseDirectionEnabled(clusterName, serviceName, clusterUuidOnRemote, serviceNameOnRemote, sourceDbNameOnRemote, targetDbNameOnRemote);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#isHive3ReverseDirectionEnabled");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| clusterUuidOnRemote | String | the uuid of the cluster on the remote CM server | [optional] |
| serviceNameOnRemote | String | the Hive3 service name on the remote CM server, more specifically on the cluster specified by clusterUuidOnRemote | [optional] |
| sourceDbNameOnRemote | String | the name of the source database on the remote CM server | [optional] |
| targetDbNameOnRemote | String | the name of the target database on the remote CM server | [optional] |
Boolean
ApiCommand listHBaseNamespaces(clusterName, serviceName)
Starts a command that lists all namespaces in HBase.
Starts a command that lists all namespaces in HBase.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiCommand result = apiInstance.listHBaseNamespaces(clusterName, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#listHBaseNamespaces");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. |
ApiCommand listHBasePeers(clusterName, serviceName)
Starts a command that retrieves all peers registered in the HBase service.
Starts a command that retrieves all peers registered in the HBase service.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiCommand result = apiInstance.listHBasePeers(clusterName, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#listHBasePeers");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. |
ApiCommand listHBaseTables(clusterName, serviceName)
Starts a command that lists tables from the HBase service.
Starts a command that lists tables from the HBase service.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiCommand result = apiInstance.listHBaseTables(clusterName, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#listHBaseTables");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. |
ApiReplicationCommandList readHistory(clusterName, scheduleId, serviceName, limit, offset, sort, status, view)
Returns a list of commands triggered by a schedule.
Returns a list of commands triggered by a schedule.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | ID of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
java.math.BigDecimal limit = new java.math.BigDecimal(); // java.math.BigDecimal | Maximum number of commands to retrieve. Optional, default value is 20.
java.math.BigDecimal offset = new java.math.BigDecimal(); // java.math.BigDecimal | Index of first command to retrieve. Optional, default value is 0.
String sort = "sort_example"; // String | The list of fields to order by. The value passed should be in the format of orderBy=field1:asc,field2:desc, where field1 will have the highest precedence. For every field provided, asc or also has to be provided. This param is optional, default behaviour is descending ordering by start time.
String status = "status_example"; // String | Desired status of retrieved commands. Optional, default behaviour is not applying any filtering, and returning all commands. Check ApiReplicationHistoryItemStatus for possible values.
String view = "summary"; // String | The view to materialize. Optional, default is summary.
try {
ApiReplicationCommandList result = apiInstance.readHistory(clusterName, scheduleId, serviceName, limit, offset, sort, status, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#readHistory");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | ID of an existing replication schedule. | |
| serviceName | String | The service name. | |
| limit | java.math.BigDecimal | Maximum number of commands to retrieve. Optional, default value is 20. | [optional] [default to 20] |
| offset | java.math.BigDecimal | Index of first command to retrieve. Optional, default value is 0. | [optional] [default to 0] |
| sort | String | The list of fields to order by. The value passed should be in the format of orderBy=field1:asc,field2:desc, where field1 will have the highest precedence. For every field provided, asc or also has to be provided. This param is optional, default behaviour is descending ordering by start time. | [optional] |
| status | String | Desired status of retrieved commands. Optional, default behaviour is not applying any filtering, and returning all commands. Check ApiReplicationHistoryItemStatus for possible values. | [optional] [enum: FAILED, RUNNING, SUCCESS] |
| view | String | The view to materialize. Optional, default is summary. | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
ApiReplicationSchedule readSchedule(clusterName, scheduleId, serviceName, view)
Returns information for a specific replication schedule.
Returns information for a specific replication schedule.
Available since API v3. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | The view to materialize.
try {
ApiReplicationSchedule result = apiInstance.readSchedule(clusterName, scheduleId, serviceName, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#readSchedule");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | Id of an existing replication schedule. | |
| serviceName | String | The service name. | |
| view | String | The view to materialize. | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
ApiReplicationScheduleList readSchedules(clusterName, serviceName, maxCommands, maxErrors, maxSchedules, maxTables, view)
Retrieves information about replication schedules.
Retrieves information about replication schedules.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
java.math.BigDecimal maxCommands = new java.math.BigDecimal(); // java.math.BigDecimal | Maximum number of commands to include in the history of replication schedules. By default, it has no limit. Pass 0 to explicitly set to unlimited.
java.math.BigDecimal maxErrors = new java.math.BigDecimal(); // java.math.BigDecimal | Maximum number of errors per Hive replication command. By default, it has no limit. Pass 0 to explicitly set to unlimited.
java.math.BigDecimal maxSchedules = new java.math.BigDecimal(); // java.math.BigDecimal | Maximum number of replication schedules to be included in the response. By default, it has no limit. Pass 0 to explicitly set to unlimited.
java.math.BigDecimal maxTables = new java.math.BigDecimal(); // java.math.BigDecimal | Maximum number of tables per Hive replication command. By default, it has no limit. Pass 0 to explicitly set to unlimited.
String view = "summary"; // String | The view to materialize.
try {
ApiReplicationScheduleList result = apiInstance.readSchedules(clusterName, serviceName, maxCommands, maxErrors, maxSchedules, maxTables, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#readSchedules");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| maxCommands | java.math.BigDecimal | Maximum number of commands to include in the history of replication schedules. By default, it has no limit. Pass 0 to explicitly set to unlimited. | [optional] [default to 0] |
| maxErrors | java.math.BigDecimal | Maximum number of errors per Hive replication command. By default, it has no limit. Pass 0 to explicitly set to unlimited. | [optional] [default to 0] |
| maxSchedules | java.math.BigDecimal | Maximum number of replication schedules to be included in the response. By default, it has no limit. Pass 0 to explicitly set to unlimited. | [optional] [default to 0] |
| maxTables | java.math.BigDecimal | Maximum number of tables per Hive replication command. By default, it has no limit. Pass 0 to explicitly set to unlimited. | [optional] [default to 0] |
| view | String | The view to materialize. | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
ApiCommand recreateCloudCredstoresOnHdfs(clusterName, serviceName)
Recreates the existing credential provider jceks files on HDFS, that are used by the given service, for replicating to the cloud.
Recreates the existing credential provider jceks files on HDFS, that are used by the given service, for replicating to the cloud.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiCommand result = apiInstance.recreateCloudCredstoresOnHdfs(clusterName, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#recreateCloudCredstoresOnHdfs");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. |
ApiCommand removeHBasePeer(clusterName, serviceName, body)
Starts a command that removes the specified HBase replication peer from the local HBase service.
Starts a command that removes the specified HBase replication peer from the local HBase service.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBasePeerId body = new ApiHBasePeerId(); // ApiHBasePeerId | ID of the peer to be removed.
try {
ApiCommand result = apiInstance.removeHBasePeer(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#removeHBasePeer");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBasePeerId | ID of the peer to be removed. | [optional] |
ApiCommand removeTablesFromHBasePeer(clusterName, serviceName, body)
Starts a command that removes tables and column families from an existing HBase replication peer.
Starts a command that removes tables and column families from an existing HBase replication peer.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBasePeerIdWithTableCFs body = new ApiHBasePeerIdWithTableCFs(); // ApiHBasePeerIdWithTableCFs | Arguments for removing tables from HBase replication peer.
try {
ApiCommand result = apiInstance.removeTablesFromHBasePeer(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#removeTablesFromHBasePeer");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBasePeerIdWithTableCFs | Arguments for removing tables from HBase replication peer. | [optional] |
Boolean rescheduleHive3ReplicationMetricsGetter(clusterName, serviceName, nextStartMins)
Set the Hive3 Replication Metrics Getter next start time.
Set the Hive3 Replication Metrics Getter next start time.
(Re)set the Hive3 Replication Metrics Getter next start time. Should be only used if the Getter needs to be manually started.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
java.math.BigDecimal nextStartMins = new java.math.BigDecimal(); // java.math.BigDecimal |
try {
Boolean result = apiInstance.rescheduleHive3ReplicationMetricsGetter(clusterName, serviceName, nextStartMins);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#rescheduleHive3ReplicationMetricsGetter");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| nextStartMins | java.math.BigDecimal | [optional] [default to 5] |
Boolean
ApiCommand runCopyListing(clusterName, serviceName, body)
Run the hdfs copy listing command.
Run the hdfs copy listing command
The copy listing command will be triggered with the provided arguments
Available since API v18. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String body = "body_example"; // String |
try {
ApiCommand result = apiInstance.runCopyListing(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runCopyListing");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | String | [optional] |
ApiCommand runHBaseReplicationRetryFailedSnapshots(clusterName, scheduleId, serviceName)
Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID.
Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | The HBase schedule ID to retry on
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiCommand result = apiInstance.runHBaseReplicationRetryFailedSnapshots(clusterName, scheduleId, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runHBaseReplicationRetryFailedSnapshots");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | The HBase schedule ID to retry on | |
| serviceName | String | The service name. |
ApiCommand runHBaseReplicationSecurityTool(clusterName, serviceName, body)
Run the hbase replication security tool.
Run the hbase replication security tool
The replication security tool is invoked against the provided arguments
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
Object body = null; // Object |
try {
ApiCommand result = apiInstance.runHBaseReplicationSecurityTool(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runHBaseReplicationSecurityTool");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | Object | [optional] |
ApiCommand runHBaseReplicationValidationTool(clusterName, serviceName, hbasePeerId)
Executes a command, which validates if HBase replication works properly for the given hbasePeerId.
Executes a command, which validates if HBase replication works properly for the given hbasePeerId
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String hbasePeerId = "hbasePeerId_example"; // String | The HBase peer ID to be validated
try {
ApiCommand result = apiInstance.runHBaseReplicationValidationTool(clusterName, serviceName, hbasePeerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runHBaseReplicationValidationTool");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| hbasePeerId | String | The HBase peer ID to be validated | [optional] |
ApiCommand runHiveReplicationQuery(clusterName, serviceName, body)
Execute a hive replication query on local HS2 service instance.
Execute a hive replication query on local HS2 service instance
The command executes hive replication query on local HS2 instance with the provided arguments
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHive3ReplicationArguments body = new ApiHive3ReplicationArguments(); // ApiHive3ReplicationArguments |
try {
ApiCommand result = apiInstance.runHiveReplicationQuery(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runHiveReplicationQuery");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHive3ReplicationArguments | [optional] |
ApiCommand runSchedule(clusterName, scheduleId, serviceName, dryRun)
Run the schedule immediately.
Run the schedule immediately.
The replication command will be triggered with the configured arguments, and will be recorded in the schedule's history.
Available since API v3. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
Boolean dryRun = false; // Boolean | Whether to execute a dry run.
try {
ApiCommand result = apiInstance.runSchedule(clusterName, scheduleId, serviceName, dryRun);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runSchedule");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | Id of an existing replication schedule. | |
| serviceName | String | The service name. | |
| dryRun | Boolean | Whether to execute a dry run. | [optional] [default to false] |
ApiCommand setCFsReplicationScope(clusterName, serviceName, body)
Starts a command that set the replication scope of the provided column families to the desired value.
Starts a command that set the replication scope of the provided column families to the desired value.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBaseSetCFsReplicationScope body = new ApiHBaseSetCFsReplicationScope(); // ApiHBaseSetCFsReplicationScope | Arguments for setting the replication scope.
try {
ApiCommand result = apiInstance.setCFsReplicationScope(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#setCFsReplicationScope");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBaseSetCFsReplicationScope | Arguments for setting the replication scope. | [optional] |
ApiCommand updateHBasePeerState(clusterName, serviceName, body)
Update HBase peer state ('DISABLE' or 'ENABLE'),.
Update HBase peer state ('DISABLE' or 'ENABLE'),
and set the related HBase replication schedules
ApiHBaseReplicationArguments.peerStatefor the given peer name (all schedules for the same source and target HBase service) according to the given state ('DISABLED' or 'ENABLED').
example json data payload: '{ "sourceRef": { "peerName": "source-peer-name", "clusterName": "Cluster Name", "serviceName": "HBase Service Name" } "peerState": "ENABLED|DISABLED" }'
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBaseReplicationUpdatePeerStateArgs body = new ApiHBaseReplicationUpdatePeerStateArgs(); // ApiHBaseReplicationUpdatePeerStateArgs | ApiHBaseReplicationUpdatePeerStateArgs
try {
ApiCommand result = apiInstance.updateHBasePeerState(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#updateHBasePeerState");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBaseReplicationUpdatePeerStateArgs | ApiHBaseReplicationUpdatePeerStateArgs | [optional] |
ApiCommand updateHBaseReplicationPeerState(clusterName, serviceName, body)
Starts a command that updates the state of an existing HBase replication peer.
Starts a command that updates the state of an existing HBase replication peer.
// 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHBaseUpdateReplicationPeerState body = new ApiHBaseUpdateReplicationPeerState(); // ApiHBaseUpdateReplicationPeerState | Arguments for operation.
try {
ApiCommand result = apiInstance.updateHBaseReplicationPeerState(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#updateHBaseReplicationPeerState");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| serviceName | String | The service name. | |
| body | ApiHBaseUpdateReplicationPeerState | Arguments for operation. | [optional] |
ApiReplicationSchedule updateSchedule(clusterName, scheduleId, serviceName, body)
Updates an existing replication schedule.
Updates an existing replication schedule.
Available since API v3. 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.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
java.math.BigDecimal scheduleId = new java.math.BigDecimal(); // java.math.BigDecimal | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
ApiReplicationSchedule body = new ApiReplicationSchedule(); // ApiReplicationSchedule |
try {
ApiReplicationSchedule result = apiInstance.updateSchedule(clusterName, scheduleId, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#updateSchedule");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| clusterName | String | ||
| scheduleId | java.math.BigDecimal | Id of an existing replication schedule. | |
| serviceName | String | The service name. | |
| body | ApiReplicationSchedule | [optional] |