跳到主要内容

创建复制任务

用于创建单向复制任务或双向复制任务,支持结构迁移、数据迁移、增量同步、对象范围等配置。

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

请求方法:POST

请求参数

参数类型是否必选说明示例
nameString复制任务名称。replication_demo
sourceDatasourceTypeString源数据源类型。枚举值请参见本文附录mysql
sourceDatasourceIdString源数据源 ID,可调用获取数据源列表接口查询。ds-source001
targetDatasourceTypeString目标数据源类型。枚举值请参见本文附录mysql
targetDatasourceIdString目标数据源 ID,可调用获取数据源列表接口查询。ds-target001
createTypeString复制方式:
  • one_way(默认):创建单向复制任务。
  • bidirectional:同时创建正向和反向复制任务,以形成双向任务。
  • bidirectional_from_existing:为现有单向复制任务添加反向任务,以形成双向任务。
one_way
existingReplicationIdString现有复制任务的 ID,可调用查询复制任务列表接口查询。createTypebidirectional_from_existing 时必填。rp-deddhxp65zbp
replicationOptionObject复制任务的参数配置,见本文配置参数详情{
"migrateSchema": true,
"migrateData": true,
"incrementalReplication": false,
"specType": "micro",
"conflictStrategy": "ignore",
"supportDDL": true
}
objectConfigObject复制对象列表,见本文复制对象详情{
"all": true
}

配置参数详情(replicationOption)

参数类型是否必选说明示例
migrateSchemaBoolean是否迁移结构,默认 truetrue
migrateDataBoolean是否迁移存量数据,默认 truetrue
incrementalReplicationBoolean是否执行增量同步,默认 falsetrue
specTypeString规格类型,可选值:
  • micro:对应 200 RPS(每秒可复制的增量数据行数)。
  • small :对应 1000 RPS。
  • medium:对应 3000 RPS。
  • large :对应 10000 RPS。
  • xlarge:对应 10000+ RPS。
micro
conflictStrategyString冲突处理策略:
  • ignore:忽略冲突。
  • abort :阻断任务执行。
  • replace:删除冲突数据并重写,只对全量复制生效。
  • drop_create :删除冲突的库表结构并重建,只对结构复制生效。
ignore
supportDDLBoolean是否支持 DDL 同步,默认 true。双向复制反向任务固定为 falsetrue

复制对象详情(objectConfig)

参数类型是否必选说明示例
allBoolean是否包含实例下所有对象,默认 falsetrue
databaseListArray数据库对象列表,all 参数为 false 时必填。详情请参见库或 Schema 对象详情

库或 Schema 对象详情(databaseList / schemaList)

参数类型是否必选说明示例
allBoolean是否包含所有子对象,默认 falsefalse
allTable / allView / allTrigger / allEvent / allFunction / allProcedureBoolean是否包含对应类型对象,默认 falsefalse
schemaListArray模式列表。
tableList / viewList / functionList / procedureList / eventList / triggerListArray指定对象列表。更多信息,请参见一般对象详情{
"databaseName": "db1",
"targetDatabase": "db1_target",
"schemaName": "public",
"targetSchema": "public_target",
"objectName": "table_a",
"targetName": "table_a_target"
}

一般对象详情

参数类型是否必选说明示例
databaseNameString源库名。db1
targetDatabaseString目标库名,默认与 databaseName 一致。db1_target
schemaNameString源 schema。源端为库 > Schema > 表三层架构时需可配置,默认为 nullpublic
targetSchemaString目标 schema。目标端为库 > Schema > 表三层架构时需可配置,默认为 nullpublic_target
objectNameString源对象名。table_a
targetNameString目标对象名,默认与源一致。table_a_target

返回参数

参数类型说明示例
replicationIdString新创建的复制任务 ID。rp-deddhxp65zbp

调用成功示例

{
"success": true,
"requestId": "Hk8l2BXJ-DJIFkILnIEIi3GUdJEy7VGI",
"data": {
"replicationId": "rp-deddhxp65zbp"
}
}

附录:数据源类型枚举值列表

分类枚举值说明
关系型数据库(RDBMS)adbpostgresql阿里云 AnalyticDB PostgreSQL
mysqlMySQL 开源数据库
oracleOracle 商业数据库
postgresqlPostgreSQL 开源数据库
tidbTiDB 分布式 HTAP 数据库
db2IBM DB2 数据库
dameng达梦数据库
kingbase金仓数据库
open_gauss华为 openGauss 数据库
gaussdb华为 GaussDB 数据库
gbaseGBase(南大通用)
goldendbGoldenDB 金融级数据库
tdsqlmysql腾讯云 TDSQL MySQL 版
oceanbasemysqlOceanBase MySQL 模式
oceanbaseoracleOceanBase Oracle 模式
polardboracle阿里云 PolarDB Oracle 兼容版
polardbx阿里云 PolarDB-X 分布式数据库
sqlserverMicrosoft SQL Server
sybaseSybase 数据库
singlestoreSingleStore(原 MemSQL)
sqldatabase通用 SQL Database(内部)
NoSQLmongodbMongoDB 文档数据库
redisRedis 数据库
OLAP / 数仓clickhouseClickHouse 列式数据库
dorisApache Doris MPP 数据库
starrocksStarRocks MPP 数据库
selectdbSelectDB(StarRocks 商业版)
greenplumGreenplum 数据仓库
redshiftAWS Redshift 数据仓库
dwsData Warehouse Service(华为)
ymatrixMatrixOne 云原生数据库
adbpostgresqlAnalyticDB PostgreSQL
tidbTiDB HTAP 数据库
大数据 / 消息队列hiveApache Hive
kafkaKafka 消息队列
datahub阿里云 DataHub
搜索elasticsearchElasticsearch 搜索引擎