ReplicationsResourceApi

All URIs are relative to /api/v58

Method HTTP request Description
addHBaseReplicationPeer POST /clusters/{clusterName}/services/{serviceName}/replications/operations/addReplicationPeer
addTablesToHBasePeer POST /clusters/{clusterName}/services/{serviceName}/replications/operations/addTablesToHBasePeer
checkHBaseTablesExist POST /clusters/{clusterName}/services/{serviceName}/replications/operations/checkTables
collectDiagnosticData POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/collectDiagnosticData
createCloudCredstoreOnHdfs POST /clusters/{clusterName}/services/{serviceName}/replications/createCloudCredstoreOnHdfs
createCredstore POST /clusters/{clusterName}/services/{serviceName}/replications/createCredstore
createSchedules POST /clusters/{clusterName}/services/{serviceName}/replications
deleteAllSchedules DELETE /clusters/{clusterName}/services/{serviceName}/replications
deleteSchedule DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}
exportAtlasEntites POST /clusters/{clusterName}/services/{serviceName}/replications/exportAtlasEntities
exportRangerServices POST /clusters/{clusterName}/services/{serviceName}/replications/exportRangerServices
fetchHBaseColumnFamilies POST /clusters/{clusterName}/services/{serviceName}/replications/operations/fetchColumnFamilies
fetchHBasePeerInfo POST /clusters/{clusterName}/services/{serviceName}/replications/operations/fetchHBasePeerInfo
forceDeleteSchedule DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/forcedDelete
generateCloudReplCredstorePassword POST /clusters/{clusterName}/services/{serviceName}/replications/generateCloudReplCredstorePassword
getReplicationState GET /clusters/{clusterName}/services/{serviceName}/replications/replicationState
isHive3ReverseDirectionEnabled GET /clusters/{clusterName}/services/{serviceName}/replications/isHive3ReverseDirectionEnabled
listHBaseNamespaces GET /clusters/{clusterName}/services/{serviceName}/replications/operations/listNamespaces
listHBasePeers GET /clusters/{clusterName}/services/{serviceName}/replications/operations/listPeers
listHBaseTables GET /clusters/{clusterName}/services/{serviceName}/replications/operations/listTables
postCopyReconciliation POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/postCopyReconciliation
readHistory GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/history
readSchedule GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}
readSchedules GET /clusters/{clusterName}/services/{serviceName}/replications
recreateCloudCredstoresOnHdfs POST /clusters/{clusterName}/services/{serviceName}/replications/recreateCloudCredstoresOnHdfs
removeHBasePeer POST /clusters/{clusterName}/services/{serviceName}/replications/operations/removeHBasePeer
removeTablesFromHBasePeer POST /clusters/{clusterName}/services/{serviceName}/replications/operations/removeTablesFromHBasePeer
rescheduleHive3ReplicationMetricsGetter POST /clusters/{clusterName}/services/{serviceName}/replications/rescheduleHive3ReplicationMetricsGetter
retrySchedule POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/retry
runCopyListing POST /clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing
runHBaseReplicationRetryFailedSnapshots POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/runHBaseReplicationRetryFailedSnapshots
runHBaseReplicationSecurityTool POST /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationSecurityTool
runHBaseReplicationValidationTool POST /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationValidationTool
runHiveReplicationQuery POST /clusters/{clusterName}/services/{serviceName}/replications/hiveReplicationQuery
runSchedule POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/run
setCFsReplicationScope POST /clusters/{clusterName}/services/{serviceName}/replications/operations/setCFsReplicationScope
updateHBasePeerState PUT /clusters/{clusterName}/services/{serviceName}/replications/updateHBasePeerState
updateHBaseReplicationPeerState POST /clusters/{clusterName}/services/{serviceName}/replications/operations/updateReplicationPeerState
updateSchedule PUT /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}

addHBaseReplicationPeer

ApiCommand addHBaseReplicationPeer(clusterName, serviceName, body)

Starts a command that adds a new replication peer to HBase.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBaseAddReplicationPeerInput Information for peer creation. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

addTablesToHBasePeer

ApiCommand addTablesToHBasePeer(clusterName, serviceName, body)

Starts a command that adds tables and column families to an existing HBase replication peer.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBasePeerIdWithTableCFs Arguments for the operation. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

checkHBaseTablesExist

ApiCommand checkHBaseTablesExist(clusterName, serviceName, body)

Starts a command that checks if the specified tables exist in HBase.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBaseTableNames Names of the tables to be checked. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

collectDiagnosticData

ApiCommand collectDiagnosticData(clusterName, scheduleId, serviceName, body, view)

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | Schedule ID
String serviceName = "serviceName_example"; // String | The service name.
ApiReplicationDiagnosticsCollectionArgs body = new ApiReplicationDiagnosticsCollectionArgs(); // ApiReplicationDiagnosticsCollectionArgs | Replication collection arguments
String view = "summary"; // String | view to materialize
try {
    ApiCommand result = apiInstance.collectDiagnosticData(clusterName, scheduleId, serviceName, body, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReplicationsResourceApi#collectDiagnosticData");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long Schedule ID
serviceName String The service name.
body ApiReplicationDiagnosticsCollectionArgs Replication collection arguments [optional]
view String view to materialize [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiCommand

Authorization

basic

HTTP request headers

createCloudCredstoreOnHdfs

ApiCommand createCloudCredstoreOnHdfs(clusterName, serviceName, force, sourceAccount)

Creates a credstore provider jceks file on HDFS for the given service. The file will store credential information for the given sourceAccount.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 = false; // 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();
}

Parameters

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] [default to false]
sourceAccount String the External Account that has been already added to this CM, for which the credstore provider jceks file will be generated [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

createCredstore

ApiCommand createCredstore(clusterName, serviceName, credstoreDirPath, force, sourceAccount)

Use the following API endpoint instead: com.cloudera.api.v50.ReplicationsResourceV50#createCloudCredstoreOnHdfs(String, boolean)

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 = false; // 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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
credstoreDirPath String [optional]
force Boolean [optional] [default to false]
sourceAccount String [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

createSchedules

ApiReplicationScheduleList createSchedules(clusterName, serviceName, body)

Creates one or more replication schedules.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiReplicationScheduleList List of the replication schedules to create. [optional]

Return type

ApiReplicationScheduleList

Authorization

basic

HTTP request headers

deleteAllSchedules

ApiReplicationScheduleList deleteAllSchedules(clusterName, serviceName)

Deletes all existing replication schedules.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.

Return type

ApiReplicationScheduleList

Authorization

basic

HTTP request headers

deleteSchedule

ApiReplicationSchedule deleteSchedule(clusterName, scheduleId, serviceName)

Deletes an existing replication schedule.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long Id of an existing replication schedule.
serviceName String The service name.

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers

exportAtlasEntites

ApiCommand exportAtlasEntites(clusterName, serviceName, body)

Exports the given Atlas Entities (defined in the API body) to a zipped file in hdfs.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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.
ApiAtlasReplicationRemoteArgs body = new ApiAtlasReplicationRemoteArgs(); // ApiAtlasReplicationRemoteArgs | 
try {
    ApiCommand result = apiInstance.exportAtlasEntites(clusterName, serviceName, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReplicationsResourceApi#exportAtlasEntites");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiAtlasReplicationRemoteArgs [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

exportRangerServices

ApiCommand exportRangerServices(clusterName, serviceName, body)

Exports the given Ranger services and policies (defined in the API body) to a zipped file.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

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]

Return type

ApiCommand

Authorization

basic

HTTP request headers

fetchHBaseColumnFamilies

ApiCommand fetchHBaseColumnFamilies(clusterName, serviceName, body, whereReplicationSet)

Starts a command that fetches column families for the desired tables.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 tables to query for column families.
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.
try {
    ApiCommand result = apiInstance.fetchHBaseColumnFamilies(clusterName, serviceName, body, whereReplicationSet);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReplicationsResourceApi#fetchHBaseColumnFamilies");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBaseTableNames Names of tables to query for column families. [optional]
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]

Return type

ApiCommand

Authorization

basic

HTTP request headers

fetchHBasePeerInfo

ApiCommand fetchHBasePeerInfo(clusterName, serviceName, body)

Starts a command that fetches information about an HBase peer by its ID.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBasePeerId ID of the fetched peer. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

forceDeleteSchedule

ApiReplicationSchedule forceDeleteSchedule(clusterName, scheduleId, serviceName)

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long Id of an existing replication schedule.
serviceName String The service name.

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers

generateCloudReplCredstorePassword

Boolean generateCloudReplCredstorePassword(clusterName, serviceName, passwordGenerateMode)

(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().

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

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]

Return type

Boolean

Authorization

basic

HTTP request headers

getReplicationState

ApiReplicationState getReplicationState(clusterName, serviceName, view)

returns the replication state. for example if incremental export is enabled, etc

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

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, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiReplicationState

Authorization

basic

HTTP request headers

isHive3ReverseDirectionEnabled

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. Bidirectional Hive3 replication policies are allowed, but only one direction can be ENABLED at the same time.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

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]

Return type

Boolean

Authorization

basic

HTTP request headers

listHBaseNamespaces

ApiCommand listHBaseNamespaces(clusterName, serviceName)

Starts a command that lists all namespaces in HBase.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.

Return type

ApiCommand

Authorization

basic

HTTP request headers

listHBasePeers

ApiCommand listHBasePeers(clusterName, serviceName)

Starts a command that retrieves all peers registered in the HBase service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.

Return type

ApiCommand

Authorization

basic

HTTP request headers

listHBaseTables

ApiCommand listHBaseTables(clusterName, serviceName)

Starts a command that lists tables from the HBase service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.

Return type

ApiCommand

Authorization

basic

HTTP request headers

postCopyReconciliation

ApiCommand postCopyReconciliation(clusterName, scheduleId, serviceName, pcrEnableCrcCheck, pcrEnableLengthCheck, pcrEnableModtimeCheck)

Starts a command that executes PostCopyReconciliation steps on a schedule.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 
String serviceName = "serviceName_example"; // String | The service name.
Boolean pcrEnableCrcCheck = true; // Boolean | 
Boolean pcrEnableLengthCheck = true; // Boolean | 
Boolean pcrEnableModtimeCheck = true; // Boolean | 
try {
    ApiCommand result = apiInstance.postCopyReconciliation(clusterName, scheduleId, serviceName, pcrEnableCrcCheck, pcrEnableLengthCheck, pcrEnableModtimeCheck);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReplicationsResourceApi#postCopyReconciliation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long
serviceName String The service name.
pcrEnableCrcCheck Boolean [optional] [default to true]
pcrEnableLengthCheck Boolean [optional] [default to true]
pcrEnableModtimeCheck Boolean [optional] [default to true]

Return type

ApiCommand

Authorization

basic

HTTP request headers

readHistory

ApiReplicationCommandList readHistory(clusterName, scheduleId, serviceName, limit, offset, sort, status, view)

Returns a list of commands triggered by a schedule.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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 desc 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long 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]
offset java.math.BigDecimal Index of first command to retrieve. Optional, default value is 0. [optional]
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 desc 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, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiReplicationCommandList

Authorization

basic

HTTP request headers

readSchedule

ApiReplicationSchedule readSchedule(clusterName, scheduleId, serviceName, view)

Returns information for a specific replication schedule.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long 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, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers

readSchedules

ApiReplicationScheduleList readSchedules(clusterName, serviceName, maxCommands, maxErrors, maxSchedules, maxTables, view)

Retrieves information about replication schedules.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

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]
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]
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]
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]
view String The view to materialize. [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiReplicationScheduleList

Authorization

basic

HTTP request headers

recreateCloudCredstoresOnHdfs

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.

Return type

ApiCommand

Authorization

basic

HTTP request headers

removeHBasePeer

ApiCommand removeHBasePeer(clusterName, serviceName, body)

Starts a command that removes the specified HBase replication peer from the local HBase service.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBasePeerId ID of the peer to be removed. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

removeTablesFromHBasePeer

ApiCommand removeTablesFromHBasePeer(clusterName, serviceName, body)

Starts a command that removes tables and column families from an existing HBase replication peer.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBasePeerIdWithTableCFs Arguments for removing tables from HBase replication peer. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

rescheduleHive3ReplicationMetricsGetter

Boolean rescheduleHive3ReplicationMetricsGetter(clusterName, serviceName, nextStartMins)

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
nextStartMins java.math.BigDecimal [optional]

Return type

Boolean

Authorization

basic

HTTP request headers

retrySchedule

ApiCommand retrySchedule(clusterName, scheduleId, serviceName)

Retry the last command of a failed replication schedule. Similar to com.cloudera.api.v3.ReplicationsResource#runSchedule but only works if the last command failed.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
try {
    ApiCommand result = apiInstance.retrySchedule(clusterName, scheduleId, serviceName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReplicationsResourceApi#retrySchedule");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long Id of an existing replication schedule.
serviceName String The service name.

Return type

ApiCommand

Authorization

basic

HTTP request headers

runCopyListing

ApiCommand runCopyListing(clusterName, serviceName, body)

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body String [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

runHBaseReplicationRetryFailedSnapshots

ApiCommand runHBaseReplicationRetryFailedSnapshots(clusterName, scheduleId, serviceName)

Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long The HBase schedule ID to retry on
serviceName String The service name.

Return type

ApiCommand

Authorization

basic

HTTP request headers

runHBaseReplicationSecurityTool

ApiCommand runHBaseReplicationSecurityTool(clusterName, serviceName, body)

Run the hbase replication security tool

The replication security tool is invoked against the provided arguments

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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.
Map<String, String> body = new Map(); // Map<String, String> | 
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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body Map<String, String> [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

runHBaseReplicationValidationTool

ApiCommand runHBaseReplicationValidationTool(clusterName, serviceName, hbasePeerId)

Executes a command, which validates if HBase replication works properly for the given hbasePeerId

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
hbasePeerId String The HBase peer ID to be validated [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

runHiveReplicationQuery

ApiCommand runHiveReplicationQuery(clusterName, serviceName, body)

Execute a hive replication query on local HS2 service instance

The command executes hive replication query on local HS2 instance with the provided arguments

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHive3ReplicationArguments [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

runSchedule

ApiCommand runSchedule(clusterName, scheduleId, serviceName, dryRun)

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.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long Id of an existing replication schedule.
serviceName String The service name.
dryRun Boolean Whether to execute a dry run. [optional] [default to false]

Return type

ApiCommand

Authorization

basic

HTTP request headers

setCFsReplicationScope

ApiCommand setCFsReplicationScope(clusterName, serviceName, body)

Starts a command that set the replication scope of the provided column families to the desired value.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBaseSetCFsReplicationScope Arguments for setting the replication scope. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

updateHBasePeerState

ApiCommand updateHBasePeerState(clusterName, serviceName, body)

Update HBase peer state ('DISABLE' or 'ENABLE'),
and set the related HBase replication schedules 

ApiHBaseReplicationArguments.peerState
for 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"  }'

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBaseReplicationUpdatePeerStateArgs ApiHBaseReplicationUpdatePeerStateArgs [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

updateHBaseReplicationPeerState

ApiCommand updateHBaseReplicationPeerState(clusterName, serviceName, body)

Starts a command that updates the state of an existing HBase replication peer.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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();
}

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body ApiHBaseUpdateReplicationPeerState Arguments for operation. [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

updateSchedule

ApiReplicationSchedule updateSchedule(clusterName, scheduleId, serviceName, body)

Updates an existing replication schedule.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.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 | 
Long scheduleId = 789L; // Long | 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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId Long Id of an existing replication schedule.
serviceName String The service name.
body ApiReplicationSchedule [optional]

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers