Query Replication Task Status

Use this API to query the status of a specified replication task, including the current subtask, progress, and incremental delay.

Request URL: /openapi/v1/replication/status

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
replicationId	String	Yes	Replication task ID.	rp-div0t0awwobr

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	true
requestId	String	Request ID.	Zo7y2QBS-djkcnZHncghz7KWdekc9PRT
data	Object	Replication task status details. See data Fields.	See the example below

data Fields

Parameter	Type	Description	Example
replicationId	String	Replication task ID.	rp-div0t0awwobr
status	String	Task status. See Task Status Values.	running
currentSubTaskType	String	Current subtask type. See Subtask Type Values.	inc_writer
subTaskList	Array	Subtask list. See Subtask Fields.	See the example below

Subtask Fields

Parameter	Type	Description	Example
subTaskType	String	Subtask type. See Subtask Type Values.	schema
status	String	Subtask status. See Task Status Values.	success
percent	Number	Subtask progress percentage. The value range is 0 to 100. Running incremental subtasks usually return 0.	100.0
delay	Integer	Incremental synchronization delay in milliseconds. This field may be absent for non-incremental subtasks.	0

Successful Invocation Example

{
  "success": true,
  "requestId": "Zo7y2QBS-djkcnZHncghz7KWdekc9PRT",
  "data": {
    "replicationId": "rp-div0t0awwobr",
    "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": 0
      }
    ]
  }
}

Result

A successful response returns the task status and subtask progress for the specified replication task.

Task Status Values

createSuccess, preChecking, preCheckSuccess, preCheckFailed, notStarted, starting, running, success, failed, suspended, abnormal, stopped, locked.

Subtask Type Values

Value	Description
schema	Schema replication.
full	Full replication.
inc_writer	Incremental replication.
trigger	Trigger replication.