ReplicationsResourceApi

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

Method HTTP request Description
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.
createCredstore POST /clusters/{clusterName}/services/{serviceName}/replications/createCredstore Creates a credstore for the given sourceAccount, which will be stored in HDFS.
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.
forceDeleteSchedule DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/forcedDelete Deletes an existing replication schedule only from the DB.
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.
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 Returns information for all replication schedules.
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.
updateSchedule PUT /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId} Updates an existing replication schedule.

collectDiagnosticData

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.

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 | 
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();
}

Parameters

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]

Return type

ApiCommand

Authorization

basic

HTTP request headers

createCredstore

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

Creates a credstore for the given sourceAccount, which will be stored in HDFS.

Creates a credstore for the given sourceAccount, which will be stored 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.
String credstoreDirPath = "credstoreDirPath_example"; // String | the directory path where to save the credstore file.
Boolean force = true; // Boolean | if the credstore file exists then: <br/> if set to true, then the credstore file will be overwritten.<br/> if set to false, then the credstore file will be untouched.
String sourceAccount = "sourceAccount_example"; // String | for which the credstore will be created
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 the directory path where to save the credstore file. [optional]
force Boolean if the credstore file exists then:
if set to true, then the credstore file will be overwritten.
if set to false, then the credstore file will be untouched. 		[optional]
sourceAccount String for which the credstore will be created [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

createSchedules

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.

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.

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.

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 | 
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();
}

Parameters

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

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers

forceDeleteSchedule

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.

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 | 
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();
}

Parameters

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

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers

getReplicationState

ApiReplicationState getReplicationState(clusterName, serviceName, view)

returns the replication state.

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

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.

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

readHistory

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

Returns a list of commands triggered by a schedule.

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 | 
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.
java.math.BigDecimal offset = new java.math.BigDecimal(); // java.math.BigDecimal | Index of first command to retrieve.
String view = "summary"; // String | The view to materialize.
try {
    ApiReplicationCommandList result = apiInstance.readHistory(clusterName, scheduleId, serviceName, limit, offset, 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 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 to 20]
offset java.math.BigDecimal Index of first command to retrieve. [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]

Return type

ApiReplicationCommandList

Authorization

basic

HTTP request headers

readSchedule

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.

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 | 
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();
}

Parameters

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]

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers

readSchedules

ApiReplicationScheduleList readSchedules(clusterName, serviceName, view)

Returns information for all replication schedules.

Returns information for all replication schedules.

Available since API v32.

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 | provides summary or detailed view, default is summary
try {
    ApiReplicationScheduleList result = apiInstance.readSchedules(clusterName, serviceName, 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.
view String provides summary or detailed view, default is summary [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY]

Return type

ApiReplicationScheduleList

Authorization

basic

HTTP request headers

rescheduleHive3ReplicationMetricsGetter

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.

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] [default to 5]

Return type

Boolean

Authorization

basic

HTTP request headers

runCopyListing

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.

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.

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 | 
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();
}

Parameters

Name Type Description Notes
clusterName String
scheduleId java.math.BigDecimal 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.

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

Parameters

Name Type Description Notes
clusterName String
serviceName String The service name.
body Object [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.

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.

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.

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 | 
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();
}

Parameters

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]

Return type

ApiCommand

Authorization

basic

HTTP request headers

updateSchedule

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.

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 | 
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();
}

Parameters

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

Return type

ApiReplicationSchedule

Authorization

basic

HTTP request headers