Query Replication Task List

Paginated query of NineData replication tasks, supporting filtering by status, data source, task type, and other conditions.

Request URL: /openapi/v1/replication/list

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
replicationId	String	No	Replication task ID.	rep-123456
status	String	No	Task status, optional values: createSuccess: Created successfully. 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
sourceDatasourceId	String	No	Source data source ID.	ds-source01
targetDatasourceId	String	No	Target data source ID.	ds-target01
datasourceId	String	No	Source or target data source ID.	ds-common01
type	String	No	Task type, optional values: default: One-way replication task. forward: Forward task of two-way replication task. backward: Backward task of two-way replication task.	default
multiActiveId	String	No	Group ID of two-way tasks, the field value is equal for forward and backward tasks, can be used with type=backward to query backward tasks.	multi-001
keyword	String	No	Name search keyword.	sales
current	Integer	No	Current page number, starting from 1, default is 1.	1
pageSize	Integer	No	Page size, default is 10.	10

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request is successful.	true
requestId	String	Request ID.	Mi6y0FCN-BHEEaHAnCFFp9DFdAAk0OUZ
data	Array	Replication task list, including the following fields: replicationId: Replication task ID. orgId: Organization ID. name: Task name. sourceDatasourceId: Source data source ID. targetDatasourceId: Target data source ID. type: Task type, see request parameters. status: Task status, see request parameters. subTaskTypeList: Sub-task type list, optional values: schema: Schema replication full: Full replication inc_writer: Incremental replication trigger: Trigger replication multiActiveId: Two-way task group ID. createTime: Creation time (UTC).	{ "replicationId": "rp-dbz73bhzopsg", "orgId": "2056935997355584", "name": "ss", "sourceDatasourceId": "ds-d5py3zneowvr", "targetDatasourceId": "ds-d5py5ljosmti", "type": "forward", "status": "preCheckFailed", "subTaskTypeList": ["schema", "full", "inc_writer"], "multiActiveId": "mul-dbz732q6ylk8", "createTime": "2025-08-11 01:08:19Z" }
current	Integer	Current page number.	1
pageSize	Integer	Page size.	10
total	Integer	Total number of records.	1

Successful Invocation Example

{
    "success": true,
    "requestId": "Sn9s8RTT-jpnmoNHnqrli2MBdoqv8QWD",
    "data": [{
        "replicationId": "rp-dbz73bhzopsg",
        "orgId": "2056935997355584",
        "name": "ss",
        "sourceDatasourceId": "ds-d5py3zneowvr",
        "targetDatasourceId": "ds-d5py5ljosmti",
        "type": "forward",
        "status": "preCheckFailed",
        "subTaskTypeList": ["schema", "full", "inc_writer"],
        "multiActiveId": "mul-dbz732q6ylk8",
        "createTime": "2025-08-11 01:08:19Z"
    }],
    "current": 1,
    "pageSize": 10,
    "total": 1
}