All URIs are relative to https://localhost/api/v42
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. |
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. |
getReplicationState | GET /clusters/{clusterName}/services/{serviceName}/replications/replicationState | returns the replication state. |
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. |
runCopyListing | POST /clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing | Run the hdfs copy listing command. |
runHBaseReplicationSecurityTool | POST /clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationSecurityTool | Run the hbase replication security tool. |
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. |
ApiCommand collectDiagnosticData(clusterName, scheduleId, serviceName, view, body)
Collect diagnostic data for a schedule, optionally for a subset of commands on that schedule, matched by schedule ID.
Collect diagnostic data for a schedule, optionally for a subset of commands on that schedule, matched by schedule ID. The returned command's resultDataUrl property, upon the commands completion, will refer to the generated diagnostic data. Available since API v11.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
Integer scheduleId = 56; // Integer | Schedule ID
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | view to materialize
ApiReplicationDiagnosticsCollectionArgs body = new ApiReplicationDiagnosticsCollectionArgs(); // ApiReplicationDiagnosticsCollectionArgs | Replication collection arguments
try {
ApiCommand result = apiInstance.collectDiagnosticData(clusterName, scheduleId, serviceName, view, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#collectDiagnosticData");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
scheduleId | Integer | 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] |
ApiReplicationScheduleList createSchedules(clusterName, serviceName, body)
Creates one or more replication schedules.
Creates one or more replication schedules.
Available since API v3. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiReplicationScheduleList body = new ApiReplicationScheduleList(); // ApiReplicationScheduleList | List of the replication schedules to create.
try {
ApiReplicationScheduleList result = apiInstance.createSchedules(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#createSchedules");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
serviceName | String | The service name. | |
body | ApiReplicationScheduleList | List of the replication schedules to create. | [optional] |
ApiReplicationScheduleList deleteAllSchedules(clusterName, serviceName)
Deletes all existing replication schedules.
Deletes all existing replication schedules.
Available since API v3. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiReplicationScheduleList result = apiInstance.deleteAllSchedules(clusterName, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#deleteAllSchedules");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
serviceName | String | The service name. |
ApiReplicationSchedule deleteSchedule(clusterName, scheduleId, serviceName)
Deletes an existing replication schedule.
Deletes an existing replication schedule.
Available since API v3. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
Integer scheduleId = 56; // Integer | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
try {
ApiReplicationSchedule result = apiInstance.deleteSchedule(clusterName, scheduleId, serviceName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#deleteSchedule");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
scheduleId | Integer | Id of an existing replication schedule. | |
serviceName | String | The service name. |
ApiReplicationState getReplicationState(clusterName, serviceName, view)
returns the replication state.
returns the replication state. for example if incremental export is enabled, etc
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | view to materialize
try {
ApiReplicationState result = apiInstance.getReplicationState(clusterName, serviceName, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#getReplicationState");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
serviceName | String | The service name. | |
view | String | view to materialize | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
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.
// 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 |
Integer scheduleId = 56; // Integer | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
Integer limit = 20; // Integer | Maximum number of commands to retrieve.
Integer offset = 0; // Integer | 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();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
scheduleId | Integer | Id of an existing replication schedule. | |
serviceName | String | The service name. | |
limit | Integer | Maximum number of commands to retrieve. | [optional] [default to 20] |
offset | Integer | 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] |
ApiReplicationSchedule readSchedule(clusterName, scheduleId, serviceName, view)
Returns information for a specific replication schedule.
Returns information for a specific replication schedule.
Available since API v3. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
Integer scheduleId = 56; // Integer | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
String view = "summary"; // String | The view to materialize.
try {
ApiReplicationSchedule result = apiInstance.readSchedule(clusterName, scheduleId, serviceName, view);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#readSchedule");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
scheduleId | Integer | Id of an existing replication schedule. | |
serviceName | String | The service name. | |
view | String | The view to materialize. | [optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, SUMMARY] |
ApiReplicationScheduleList readSchedules(clusterName, serviceName, view)
Returns information for all replication schedules.
Returns information for all replication schedules.
Available since API v32.
// 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();
}
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] |
ApiCommand runCopyListing(clusterName, serviceName, body)
Run the hdfs copy listing command.
Run the hdfs copy listing command
The copy listing command will be triggered with the provided arguments
Available since API v18. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
String body = "body_example"; // String |
try {
ApiCommand result = apiInstance.runCopyListing(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runCopyListing");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
serviceName | String | The service name. | |
body | String | [optional] |
ApiCommand runHBaseReplicationSecurityTool(clusterName, serviceName, body)
Run the hbase replication security tool.
Run the hbase replication security tool
The replication security tool is invoked against the provided arguments
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
Object body = null; // Object |
try {
ApiCommand result = apiInstance.runHBaseReplicationSecurityTool(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runHBaseReplicationSecurityTool");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
serviceName | String | The service name. | |
body | Object | [optional] |
ApiCommand runHiveReplicationQuery(clusterName, serviceName, body)
Execute a hive replication query on local HS2 service instance.
Execute a hive replication query on local HS2 service instance
The command executes hive replication query on local HS2 instance with the provided arguments
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
String serviceName = "serviceName_example"; // String | The service name.
ApiHive3ReplicationArguments body = new ApiHive3ReplicationArguments(); // ApiHive3ReplicationArguments |
try {
ApiCommand result = apiInstance.runHiveReplicationQuery(clusterName, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runHiveReplicationQuery");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
serviceName | String | The service name. | |
body | ApiHive3ReplicationArguments | [optional] |
ApiCommand runSchedule(clusterName, scheduleId, serviceName, dryRun)
Run the schedule immediately.
Run the schedule immediately.
The replication command will be triggered with the configured arguments, and will be recorded in the schedule's history.
Available since API v3. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
Integer scheduleId = 56; // Integer | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
Boolean dryRun = false; // Boolean | Whether to execute a dry run.
try {
ApiCommand result = apiInstance.runSchedule(clusterName, scheduleId, serviceName, dryRun);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#runSchedule");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
scheduleId | Integer | Id of an existing replication schedule. | |
serviceName | String | The service name. | |
dryRun | Boolean | Whether to execute a dry run. | [optional] [default to false] |
ApiReplicationSchedule updateSchedule(clusterName, scheduleId, serviceName, body)
Updates an existing replication schedule.
Updates an existing replication schedule.
Available since API v3. Only available with Cloudera Manager Enterprise Edition.
// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ReplicationsResourceApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
ReplicationsResourceApi apiInstance = new ReplicationsResourceApi();
String clusterName = "clusterName_example"; // String |
Integer scheduleId = 56; // Integer | Id of an existing replication schedule.
String serviceName = "serviceName_example"; // String | The service name.
ApiReplicationSchedule body = new ApiReplicationSchedule(); // ApiReplicationSchedule |
try {
ApiReplicationSchedule result = apiInstance.updateSchedule(clusterName, scheduleId, serviceName, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReplicationsResourceApi#updateSchedule");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
clusterName | String | ||
scheduleId | Integer | Id of an existing replication schedule. | |
serviceName | String | The service name. | |
body | ApiReplicationSchedule | [optional] |