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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| replicationId | String | Yes | Replication task ID, you can obtain replicationId by calling the Query Replication Task List interface. | rep-123456 |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| requestId | String | Request ID. | Mi6y0FCN-BHEEaHAnCFFp9DFdAAk0OUZ |
| replicationId | String | Replication task ID. | rp-dbzfwn1n4f9b |
| status | String | Task status, possible values:
| running |
| currentSubTaskType | String | The type of the current sub-task being executed, possible values:
| inc_writer |
| subTaskList | Array | Sub-task list, including the following fields:
| { "subTaskType": "schema", "status": "success", "percent": 100.0 } |
| current | Integer | Current page number. | 1 |
| pageSize | Integer | Page size. | 10 |
| total | Integer | Total 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
}]
}
}