Information about a replication command.
This object holds all the information a regular ApiCommand object provides, and adds specific information about the results of a replication command. Depending on the type of the service where the replication was run, a different result property will be populated.| name | data type | description |
|---|---|---|
| hdfsResult | ApiHdfsReplicationResult | Results for replication commands on HDFS services. |
| ozoneResult | ApiOzoneReplicationResult | Results for replication commands on OZONE services. |
| hiveResult | ApiHiveReplicationResult | Results for replication commands on Hive services. |
| hiveOnTezResult | ApiHiveOnTezReplicationResult | Results for replication commands on HiveOnTez services. |
| hbaseInfo | ApiHBaseReplicationInfo | |
| rangerResult | ApiRangerReplicationResult | |
| icebergResult | ApiIcebergReplicationResult | |
| apiReplicationCommandsWithSameIntent | array of ApiReplicationCommand | |
| apiAtlasReplicationResult | ApiAtlasReplicationResult | |
Properties inherited from ApiCommand |
||
| id | number | The command ID. |
| name | string | The command name. |
| startTime | string | The start time. |
| endTime | string | The end time, if the command is finished. |
| active | boolean | Whether the command is currently active. |
| success | boolean | If the command is finished, whether it was successful. |
| resultMessage | string | If the command is finished, the result message. |
| resultDataUrl | string | URL to the command's downloadable result data, if any exists. |
| clusterRef | ApiClusterRef | Reference to the cluster (for cluster commands only). |
| serviceRef | ApiServiceRef | Reference to the service (for service commands only). |
| roleRef | ApiRoleRef | Reference to the role (for role commands only). |
| hostRef | ApiHostRef | Reference to the host (for host commands only). |
| parent | ApiCommand | Reference to the parent command, if any. |
| children | ApiCommandList | List of child commands. Only available in the full view.
The list contains only the summary view of the children. |
| canRetry | boolean | If the command can be retried. Available since V11 |
Example
{
"hdfsResult" : {
"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" : [ "...", "..." ]
},
"ozoneResult" : {
"commandResultMessage" : "...",
"replicationType" : "INCREMENTAL_ONLY",
"replicationCommandType" : "FULL_FILE_LISTING_FALLBACK",
"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" : [ "...", "..." ]
},
"hiveResult" : {
"phase" : "...",
"tableCount" : 12345,
"tables" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ],
"impalaUDFCount" : 12345,
"hiveUDFCount" : 12345,
"impalaUDFs" : [ {
"database" : "...",
"signature" : "..."
}, {
"database" : "...",
"signature" : "..."
} ],
"hiveUDFs" : [ {
"database" : "...",
"signature" : "..."
}, {
"database" : "...",
"signature" : "..."
} ],
"errorCount" : 12345,
"errors" : [ {
"database" : "...",
"tableName" : "...",
"impalaUDF" : "...",
"hiveUDF" : "...",
"error" : "..."
}, {
"database" : "...",
"tableName" : "...",
"impalaUDF" : "...",
"hiveUDF" : "...",
"error" : "..."
} ],
"dataReplicationResult" : {
"progress" : 12345,
"throughput" : 12345.0,
"remainingTime" : 12345,
"estimatedCompletionTime" : "...",
"counters" : [ { }, { } ],
"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" : [ "...", "..." ]
},
"dryRun" : true,
"runAsUser" : "...",
"runOnSourceAsUser" : "...",
"logPath" : "...",
"directoryForMetadata" : "...",
"statsAvailable" : true,
"dbProcessed" : 12345,
"tableProcessed" : 12345,
"partitionProcessed" : 12345,
"functionProcessed" : 12345,
"indexProcessed" : 12345,
"statsProcessed" : 12345,
"dbExpected" : 12345,
"tableExpected" : 12345,
"partitionExpected" : 12345,
"functionExpected" : 12345,
"indexExpected" : 12345,
"statsExpected" : 12345
},
"hiveOnTezResult" : {
"type" : "...",
"status" : "...",
"error" : "...",
"tablesCurrent" : 12345,
"tablesTotal" : 12345,
"functionsCurrent" : 12345,
"functionsTotal" : 12345,
"eventsCurrent" : 12345,
"eventsTotal" : 12345,
"policiesCurrent" : 12345,
"policiesTotal" : 12345,
"entitiesCurrent" : 12345,
"entitiesTotal" : 12345,
"origin" : "TARGET",
"endDateOnSrc" : "...",
"endDateOnTgt" : "..."
},
"hbaseInfo" : {
"replicationOperations" : [ "...", "..." ]
},
"rangerResult" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : {
"progress" : 12345,
"throughput" : 12345.0,
"remainingTime" : 12345,
"estimatedCompletionTime" : "...",
"counters" : [ { }, { } ],
"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" : [ "...", "..." ]
}
},
"icebergResult" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"apiReplicationCommandsWithSameIntent" : [ {
"hdfsResult" : {
"progress" : 12345,
"throughput" : 12345.0,
"remainingTime" : 12345,
"estimatedCompletionTime" : "...",
"counters" : [ { }, { } ],
"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" : [ "...", "..." ]
},
"ozoneResult" : {
"commandResultMessage" : "...",
"replicationType" : "INCREMENTAL_ONLY",
"replicationCommandType" : "FULL_FILE_LISTING",
"progress" : 12345,
"throughput" : 12345.0,
"remainingTime" : 12345,
"estimatedCompletionTime" : "...",
"counters" : [ { }, { } ],
"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" : [ "...", "..." ]
},
"hiveResult" : {
"phase" : "...",
"tableCount" : 12345,
"tables" : [ { }, { } ],
"impalaUDFCount" : 12345,
"hiveUDFCount" : 12345,
"impalaUDFs" : [ { }, { } ],
"hiveUDFs" : [ { }, { } ],
"errorCount" : 12345,
"errors" : [ { }, { } ],
"dataReplicationResult" : { },
"dryRun" : true,
"runAsUser" : "...",
"runOnSourceAsUser" : "...",
"logPath" : "...",
"directoryForMetadata" : "...",
"statsAvailable" : true,
"dbProcessed" : 12345,
"tableProcessed" : 12345,
"partitionProcessed" : 12345,
"functionProcessed" : 12345,
"indexProcessed" : 12345,
"statsProcessed" : 12345,
"dbExpected" : 12345,
"tableExpected" : 12345,
"partitionExpected" : 12345,
"functionExpected" : 12345,
"indexExpected" : 12345,
"statsExpected" : 12345
},
"hiveOnTezResult" : {
"type" : "...",
"status" : "...",
"error" : "...",
"tablesCurrent" : 12345,
"tablesTotal" : 12345,
"functionsCurrent" : 12345,
"functionsTotal" : 12345,
"eventsCurrent" : 12345,
"eventsTotal" : 12345,
"policiesCurrent" : 12345,
"policiesTotal" : 12345,
"entitiesCurrent" : 12345,
"entitiesTotal" : 12345,
"origin" : "TARGET",
"endDateOnSrc" : "...",
"endDateOnTgt" : "..."
},
"hbaseInfo" : {
"replicationOperations" : [ "...", "..." ]
},
"rangerResult" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : { }
},
"icebergResult" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"apiReplicationCommandsWithSameIntent" : [ { }, { } ],
"apiAtlasReplicationResult" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "STOPPING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : { },
"serviceRef" : { },
"roleRef" : { },
"hostRef" : { },
"parent" : { },
"children" : { },
"canRetry" : true
},
"children" : {
"items" : [ { }, { } ]
},
"canRetry" : true
}, {
"hdfsResult" : {
"progress" : 12345,
"throughput" : 12345.0,
"remainingTime" : 12345,
"estimatedCompletionTime" : "...",
"counters" : [ { }, { } ],
"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" : [ "...", "..." ]
},
"ozoneResult" : {
"commandResultMessage" : "...",
"replicationType" : "INCREMENTAL_ONLY",
"replicationCommandType" : "INCREMENTAL",
"progress" : 12345,
"throughput" : 12345.0,
"remainingTime" : 12345,
"estimatedCompletionTime" : "...",
"counters" : [ { }, { } ],
"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" : [ "...", "..." ]
},
"hiveResult" : {
"phase" : "...",
"tableCount" : 12345,
"tables" : [ { }, { } ],
"impalaUDFCount" : 12345,
"hiveUDFCount" : 12345,
"impalaUDFs" : [ { }, { } ],
"hiveUDFs" : [ { }, { } ],
"errorCount" : 12345,
"errors" : [ { }, { } ],
"dataReplicationResult" : { },
"dryRun" : true,
"runAsUser" : "...",
"runOnSourceAsUser" : "...",
"logPath" : "...",
"directoryForMetadata" : "...",
"statsAvailable" : true,
"dbProcessed" : 12345,
"tableProcessed" : 12345,
"partitionProcessed" : 12345,
"functionProcessed" : 12345,
"indexProcessed" : 12345,
"statsProcessed" : 12345,
"dbExpected" : 12345,
"tableExpected" : 12345,
"partitionExpected" : 12345,
"functionExpected" : 12345,
"indexExpected" : 12345,
"statsExpected" : 12345
},
"hiveOnTezResult" : {
"type" : "...",
"status" : "...",
"error" : "...",
"tablesCurrent" : 12345,
"tablesTotal" : 12345,
"functionsCurrent" : 12345,
"functionsTotal" : 12345,
"eventsCurrent" : 12345,
"eventsTotal" : 12345,
"policiesCurrent" : 12345,
"policiesTotal" : 12345,
"entitiesCurrent" : 12345,
"entitiesTotal" : 12345,
"origin" : "TARGET",
"endDateOnSrc" : "...",
"endDateOnTgt" : "..."
},
"hbaseInfo" : {
"replicationOperations" : [ "...", "..." ]
},
"rangerResult" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : { }
},
"icebergResult" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"apiReplicationCommandsWithSameIntent" : [ { }, { } ],
"apiAtlasReplicationResult" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STARTED"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : { },
"serviceRef" : { },
"roleRef" : { },
"hostRef" : { },
"parent" : { },
"children" : { },
"canRetry" : true
},
"children" : {
"items" : [ { }, { } ]
},
"canRetry" : true
} ],
"apiAtlasReplicationResult" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "BUSY"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "STARTED"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : { },
"children" : {
"items" : [ { }, { } ]
},
"canRetry" : true
},
"children" : {
"items" : [ {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : { },
"serviceRef" : { },
"roleRef" : { },
"hostRef" : { },
"parent" : { },
"children" : { },
"canRetry" : true
}, {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : { },
"serviceRef" : { },
"roleRef" : { },
"hostRef" : { },
"parent" : { },
"children" : { },
"canRetry" : true
} ]
},
"canRetry" : true
}