Skip to main content

Query Replication Task Status

Retrieve the status information of a specified replication task, including the current sub-task being executed and its progress.

Request URL: /openapi/v1/replication/status

Request Method: GET

Request Parameters

ParameterTypeRequiredDescriptionExample
replicationIdStringYesReplication task ID, you can obtain replicationId by calling the Query Replication Task List interface.rep-123456

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request was successful.true
requestIdStringRequest ID.Mi6y0FCN-BHEEaHAnCFFp9DFdAAk0OUZ
replicationIdStringReplication task ID.rp-dbzfwn1n4f9b
statusStringTask status, possible values:
  • createSuccess: Creation successful.
  • preChecking: Pre-checking in progress.
  • preCheckSuccess: Pre-check successful.
  • preCheckFailed: Pre-check failed.
  • notStarted: Pending start.
  • starting: Starting.
  • running: Running.
  • success: Completed.
  • failed: Failed.
  • suspended: Suspended.
  • abnormal: Abnormal.
  • stopped: Stopped.
  • locked: Locked.
running
currentSubTaskTypeStringThe type of the current sub-task being executed, possible values:
  • schema: Schema replication.
  • full: Full replication.
  • inc_writer: Incremental replication.
  • trigger: Trigger replication.
inc_writer
subTaskListArraySub-task list, including the following fields:
  • subTaskType: Sub-task type, see currentSubTaskType for possible values.
  • status: Task status, see status for possible values.
  • percent: Progress percentage (0-100, fixed at 0 for incremental replication).
  • delay: Incremental synchronization delay (milliseconds).
{
"subTaskType": "schema",
"status": "success",
"percent": 100.0
}
currentIntegerCurrent page number.1
pageSizeIntegerPage size.10
totalIntegerTotal number of records.1

Successful Invocation Example

{
"success": true,
"requestId": "Xl1h5BXI-gmkjcLLnofiv3AZdmix8OQX",
"data": {
"replicationId": "rp-dbzfwn1n4f9b",
"status": "running",
"currentSubTaskType": "inc_writer",
"subTaskList": [{
"subTaskType": "schema",
"status": "success",
"percent": 100.0
}, {
"subTaskType": "full",
"status": "success",
"percent": 100.0
}, {
"subTaskType": "inc_writer",
"status": "running",
"percent": 0.0,
"delay": 672
}, {
"subTaskType": "trigger",
"status": "notStarted",
"percent": 0.0
}]
}
}