Query Replication Tasks
Queries replication tasks by page. You can filter by task ID, status, data source, task type, bidirectional task group, and task name keyword.
Request URL: /openapi/v1/replication/list
Request Method: GET
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| replicationId | String | No | Replication task ID. | rp-deddhxp65zbp |
| status | String | No | Task status. See Task Status Values. | running |
| sourceDatasourceId | String | No | Source data source ID. | ds-source001 |
| targetDatasourceId | String | No | Target data source ID. | ds-target001 |
| datasourceId | String | No | Source or target data source ID. | ds-common001 |
| type | String | No | Task type. See Task Type Values. | default |
| multiActiveId | String | No | Bidirectional task group ID. The forward and backward tasks share the same value. You can use it with type=backward to query backward tasks. | mul-dbz732q6ylk8 |
| keyword | String | No | Task name keyword. | sales |
| current | Integer | No | Page number, starting from 1. The default value is 1. | 1 |
| pageSize | Integer | No | Number of records per page. The default value is 10. | 10 |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| requestId | String | Request ID. | Wm0i7VHR-IOPHyAAnHLMy8REdJPq6NGI |
| data | Array | Replication task list. See Replication Task Fields. | See the example below |
| current | Integer | Current page number. | 1 |
| pageSize | Integer | Number of records per page. | 10 |
| total | Integer | Total number of matching records. | 1066 |
Replication Task Fields
| Parameter | Type | Description | Example |
|---|---|---|---|
| replicationId | String | Replication task ID. | rp-div0t0awwobr |
| orgId | String | Organization ID. | 2056935997355584 |
| name | String | Replication task name. | char_clob |
| sourceDatasourceId | String | Source data source ID. | ds-dimg0bnlkjwg |
| targetDatasourceId | String | Target data source ID. | ds-d59tvhis5v0z |
| type | String | Task type. See Task Type Values. | default |
| status | String | Task status. See Task Status Values. | running |
| subTaskTypeList | Array | Subtask type list. See Subtask Type Values. | ["schema", "full", "inc_writer"] |
| multiActiveId | String | Bidirectional task group ID. This field may be absent for one-way tasks. | mul-dbz732q6ylk8 |
| createTime | String | Creation time in UTC. | 2026-05-29 08:33:45Z |
Successful Invocation Example
{
"success": true,
"requestId": "Wm0i7VHR-IOPHyAAnHLMy8REdJPq6NGI",
"data": [
{
"replicationId": "rp-div0t0awwobr",
"orgId": "2056935997355584",
"name": "char_clob",
"sourceDatasourceId": "ds-dimg0bnlkjwg",
"targetDatasourceId": "ds-d59tvhis5v0z",
"type": "default",
"status": "running",
"subTaskTypeList": ["schema", "full", "inc_writer"],
"createTime": "2026-05-29 08:33:45Z"
}
],
"current": 1,
"pageSize": 5,
"total": 1066
}
Task Status Values
| Value | Description |
|---|---|
| createSuccess | Created successfully. |
| preChecking | Prechecking. |
| preCheckSuccess | Precheck succeeded. |
| preCheckFailed | Precheck failed. |
| notStarted | Pending start. |
| starting | Starting. |
| running | Running. |
| success | Completed. |
| failed | Failed. |
| suspended | Suspended. |
| abnormal | Abnormal. |
| stopped | Stopped. |
| locked | Locked. |
Task Type Values
| Value | Description |
|---|---|
| default | One-way replication task. |
| forward | Forward task of a bidirectional replication task. |
| backward | Backward task of a bidirectional replication task. |
Subtask Type Values
| Value | Description |
|---|---|
| schema | Schema replication. |
| full | Full replication. |
| inc_writer | Incremental replication. |
| trigger | Trigger replication. |