ReplicationsResource Resource

DELETE /clusters/{clusterName}/services/{serviceName}/replications

Deletes all existing replication schedules.

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

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
Response Body
media type data type description
application/json ApiReplicationScheduleList (JSON) List of deleted replication schedules.

GET /clusters/{clusterName}/services/{serviceName}/replications

Returns information for all replication schedules.

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

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
view query The view to materialize. summary
Response Body
media type data type description
application/json ApiReplicationScheduleList (JSON) List of replication schedules.

GET /clusters/{clusterName}/services/{serviceName}/replications

Returns information for all replication schedules.

Available since API v11.

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
limits query Various limits on contents of returned schedules. n/a
Response Body
media type data type description
application/json ApiReplicationScheduleList (JSON) List of replication schedules.

POST /clusters/{clusterName}/services/{serviceName}/replications

Creates one or more replication schedules.

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

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
Request Body
media type data type description
application/json ApiReplicationScheduleList (JSON) List of the replication schedules to create.
Response Body
media type data type description
application/json ApiReplicationScheduleList (JSON) List of newly added replication schedules.

POST /clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing

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.

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json ApiCommand (JSON) Information about the submitted command.

GET /clusters/{clusterName}/services/{serviceName}/replications/replicationState

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

Request Parameters
name type description default
clusterName path n/a
serviceName path The service name. n/a
view query view to materialize summary
Response Body
media type data type description
application/json ApiReplicationState (JSON) replicate state object.

DELETE /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}

Deletes an existing replication schedule.

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

Request Parameters
name type description default
clusterName path n/a
scheduleId path Id of an existing replication schedule. n/a
serviceName path The service name. n/a
Response Body
media type data type description
application/json ApiReplicationSchedule (JSON) The deleted replication schedule.

GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}

Returns information for a specific replication schedule.

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

Request Parameters
name type description default
clusterName path n/a
scheduleId path Id of an existing replication schedule. n/a
serviceName path The service name. n/a
view query The view to materialize. summary
Response Body
media type data type description
application/json ApiReplicationSchedule (JSON) Replication schedule.

PUT /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}

Updates an existing replication schedule.

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

Request Parameters
name type description default
clusterName path n/a
scheduleId path Id of an existing replication schedule. n/a
serviceName path The service name. n/a
Request Body
media type data type
application/json ApiReplicationSchedule (JSON)
Response Body
media type data type description
application/json ApiReplicationSchedule (JSON) The replication schedule after the update.

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. The returned command's resultDataUrl property, upon the commands completion, will refer to the generated diagnostic data. Available since API v11.

Request Parameters
name type description default
clusterName path n/a
scheduleId path Schedule ID n/a
serviceName path The service name. n/a
view query view to materialize summary
Request Body
media type data type description
application/json ApiReplicationDiagnosticsCollectionArgs (JSON) Replication collection arguments
Response Body
media type data type description
application/json ApiCommand (JSON) Command generated to collect the diagnostics data.

GET /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/history

Returns a list of commands triggered by a schedule.

Request Parameters
name type description default
clusterName path n/a
scheduleId path Id of an existing replication schedule. n/a
serviceName path The service name. n/a
limit query Maximum number of commands to retrieve. 20
offset query Index of first command to retrieve. 0
view query The view to materialize. summary
Response Body
media type data type description
application/json ApiReplicationCommandList (JSON) List of commands for the schedule.

POST /clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/run

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.

Request Parameters
name type description default
clusterName path n/a
scheduleId path Id of an existing replication schedule. n/a
serviceName path The service name. n/a
dryRun query Whether to execute a dry run. false
Response Body
media type data type description
application/json ApiCommand (JSON) Information about the submitted command.