ApiOzoneReplicationResult Data Model

Detailed information about an OZONE replication job.

Properties
name data type description
commandResultMessage string Contains the command execution's "result message". If there was an error during the command execution this contains the returned error string.
replicationType OzoneReplicationType The replication type that was set just before the current replication run. Available since API v54.
replicationCommandType OzoneReplicationCommandType The replication command type that was set during the current replication run, after all checks have been performed but still no data related operations were done. Available since API v54.
Properties inherited from ApiHdfsReplicationResult
progress number The file copy progress percentage.
throughput number The data throughput in KB/s.
remainingTime number The time remaining for mapper phase (seconds).
estimatedCompletionTime string The estimated completion time for the mapper phase.
counters array of ApiHdfsReplicationCounter The counters collected from the replication job.

Starting with API v4, the full list of counters is only available in the full view.
numFilesDryRun number The number of files found to copy.
numBytesDryRun number The number of bytes found to copy.
numFilesExpected number The number of files expected to be copied.
numBytesExpected number The number of bytes expected to be copied.
numFilesCopied number The number of files actually copied.
numBytesCopied number The number of bytes actually copied.
numFilesSkipped number The number of files that were unchanged and thus skipped during copying.
numBytesSkipped number The aggregate number of bytes in the skipped files.
numFilesDeleted number The number of files deleted since they were present at destination, but missing from source.
numFilesCopyFailed number The number of files for which copy failed.
numBytesCopyFailed number The aggregate number of bytes in the files for which copy failed.
setupError string The error that happened during job setup, if any.
jobId string Read-only. The MapReduce job ID for the replication job. Available since API v4.

This can be used to query information about the replication job from the MapReduce server where it was executed. Refer to the "/activities" resource for services for further details.
jobDetailsUri string Read-only. The URI (relative to the CM server's root) where to find the Activity Monitor page for the job. Available since API v4.
dryRun boolean Whether this was a dry run.
snapshottedDirs array of string The list of directories for which snapshots were taken and used as part of this replication.
runAsUser string Returns run-as user name. Available since API v11.
runOnSourceAsUser string Returns run-as user name for source cluster. Available since API v18.
logPath string Returns HDFS path of DistCp execution log files. Available since API v33.
failedFiles array of string The list of files that failed during replication. Available since API v11.

Example

{
  "commandResultMessage" : "...",
  "replicationType" : "INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING",
  "replicationCommandType" : "FULL_FILE_LISTING",
  "progress" : 12345,
  "throughput" : 12345.0,
  "remainingTime" : 12345,
  "estimatedCompletionTime" : "...",
  "counters" : [ {
    "group" : "...",
    "name" : "...",
    "value" : 12345
  }, {
    "group" : "...",
    "name" : "...",
    "value" : 12345
  } ],
  "numFilesDryRun" : 12345,
  "numBytesDryRun" : 12345,
  "numFilesExpected" : 12345,
  "numBytesExpected" : 12345,
  "numFilesCopied" : 12345,
  "numBytesCopied" : 12345,
  "numFilesSkipped" : 12345,
  "numBytesSkipped" : 12345,
  "numFilesDeleted" : 12345,
  "numFilesCopyFailed" : 12345,
  "numBytesCopyFailed" : 12345,
  "setupError" : "...",
  "jobId" : "...",
  "jobDetailsUri" : "...",
  "dryRun" : true,
  "snapshottedDirs" : [ "...", "..." ],
  "runAsUser" : "...",
  "runOnSourceAsUser" : "...",
  "logPath" : "...",
  "failedFiles" : [ "...", "..." ]
}