跳到主要内容

查询复制任务列表

分页查询 NineData 复制任务,支持按状态、数据源、任务类型等条件筛选。

请求地址:/openapi/v1/replication/list

请求方法:GET

请求参数

参数类型是否必选说明示例
replicationIdString复制任务 ID。rep-123456
statusString任务状态,可选值:
  • createSuccess:创建成功。
  • preChecking:预检查中。
  • preCheckSuccess:预检查成功。
  • preCheckFailed:预检查失败。
  • notStarted:待启动。
  • starting:启动中。
  • running:运行中。
  • success:已完成。
  • failed:运行失败。
  • suspended:已暂停。
  • abnormal:异常。
  • stopped:已终止。
  • locked:已锁定。
running
sourceDatasourceIdString源数据源 ID。ds-source01
targetDatasourceIdString目标数据源 ID。ds-target01
datasourceIdString源或目标数据源 ID。ds-common01
typeString任务类型,可选值:
  • default:单向复制任务。
  • forward:双向复制任务的正向任务。
  • backward:双向复制任务的反向任务。
default
multiActiveIdString双向任务的分组 ID,正反向任务该字段值相等,可配合 type=backward 查询反向任务。multi-001
keywordString名称搜索关键字。sales
currentInteger当前页码,从 1 开始,默认 1。1
pageSizeInteger每页大小,默认 10。10

返回参数

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID。Mi6y0FCN-BHEEaHAnCFFp9DFdAAk0OUZ
dataArray复制任务列表,包含如下字段:
  • replicationId:复制任务 ID。
  • orgId:组织 ID。
  • name:任务名称。
  • sourceDatasourceId:源数据源 ID。
  • targetDatasourceId:目标数据源 ID。
  • type:任务类型,详见请求参数。
  • status:任务状态,详见请求参数。
  • subTaskTypeList:子任务类型列表,可选值:
    • schema:结构复制
    • full:全量复制
    • inc_writer:增量复制
    • trigger:触发器复制
  • multiActiveId:双向任务分组 ID。
  • createTime:创建时间(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"
}
currentInteger当前页码。1
pageSizeInteger每页大小。10
totalInteger总记录数。1

调用成功示例

{
"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
}