创建复制任务
用于创建单向复制任务或双向复制任务,支持结构迁移、数据迁移、增量同步、对象范围等配置。
请求地址:/openapi/v1/replication/create
请求方法:POST
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| name | String | 是 | 复制任务名称。 | replication_demo |
| sourceDatasourceType | String | 是 | 源数据源类型。枚举值请参见本文附录。 | mysql |
| sourceDatasourceId | String | 是 | 源数据源 ID,可调用获取数据源列表接口查询。 | ds-source001 |
| targetDatasourceType | String | 是 | 目标数据源类型。枚举值请参见本文附录。 | mysql |
| targetDatasourceId | String | 是 | 目标数据源 ID,可调用获取数据源列表接口查询。 | ds-target001 |
| createType | String | 否 | 复制方式:
| one_way |
| existingReplicationId | String | 否 | 现有复制任务的 ID,可调用查询复制任务列表接口查询。createType 为 bidirectional_from_existing 时必填。 | rp-deddhxp65zbp |
| replicationOption | Object | 是 | 复制任务的参数配置,见本文配置参数详情。 | { "migrateSchema": true, "migrateData": true, "incrementalReplication": false, "specType": "micro", "conflictStrategy": "ignore", "supportDDL": true } |
| objectConfig | Object | 是 | 复制对象列表,见本文复制对象详情。 | { "all": true } |
配置参数详情(replicationOption)
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| migrateSchema | Boolean | 否 | 是否迁移结构,默认 true。 | true |
| migrateData | Boolean | 否 | 是否迁移存量数据,默认 true。 | true |
| incrementalReplication | Boolean | 否 | 是否执行增量同步,默认 false。 | true |
| specType | String | 否 | 规格类型,可选值:
| micro |
| conflictStrategy | String | 是 | 冲突处理策略:
| ignore |
| supportDDL | Boolean | 否 | 是否支持 DDL 同步,默认 true。双向复制反向任务固定为 false。 | true |
复制对象详情(objectConfig)
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| all | Boolean | 否 | 是否包含实例下所有对象,默认 false。 | true |
| databaseList | Array | 否 | 数据库对象列表,all 参数为 false 时必填。详情请参见库或 Schema 对象详情。 | 无 |
库或 Schema 对象详情(databaseList / schemaList)
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| all | Boolean | 否 | 是否包含所有子对象,默认 false。 | false |
| allTable / allView / allTrigger / allEvent / allFunction / allProcedure | Boolean | 否 | 是否包含对应类型对象,默认 false。 | false |
| schemaList | Array | 否 | 模式列表。 | 无 |
| tableList / viewList / functionList / procedureList / eventList / triggerList | Array | 否 | 指定对象列表。更多信息,请参见一般对象详情 | { "databaseName": "db1", "targetDatabase": "db1_target", "schemaName": "public", "targetSchema": "public_target", "objectName": "table_a", "targetName": "table_a_target" } |
一般对象详情
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| databaseName | String | 是 | 源库名。 | db1 |
| targetDatabase | String | 否 | 目标库名,默认与 databaseName 一致。 | db1_target |
| schemaName | String | 否 | 源 schema。源端为库 > Schema > 表三层架构时需可配置,默认为 null。 | public |
| targetSchema | String | 否 | 目标 schema。目标端为库 > Schema > 表三层架构时需可配置,默认为 null。 | public_target |
| objectName | String | 是 | 源对象名。 | table_a |
| targetName | String | 否 | 目标对象名,默认与源一致。 | table_a_target |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| replicationId | String | 新创建的复制任务 ID。 | rp-deddhxp65zbp |
调用成功示例
{
"success": true,
"requestId": "Hk8l2BXJ-DJIFkILnIEIi3GUdJEy7VGI",
"data": {
"replicationId": "rp-deddhxp65zbp"
}
}
附录:数据源类型枚举值列表
| 分类 | 枚举值 | 说明 |
|---|---|---|
| 关系型数据库(RDBMS) | adbpostgresql | 阿里云 AnalyticDB PostgreSQL |
| mysql | MySQL 开源数据库 | |
| oracle | Oracle 商业数据库 | |
| postgresql | PostgreSQL 开源数据库 | |
| tidb | TiDB 分布式 HTAP 数据库 | |
| db2 | IBM DB2 数据库 | |
| dameng | 达梦数据库 | |
| kingbase | 金仓数据库 | |
| open_gauss | 华为 openGauss 数据库 | |
| gaussdb | 华为 GaussDB 数据库 | |
| gbase | GBase(南大通用) | |
| goldendb | GoldenDB 金融级数据库 | |
| tdsqlmysql | 腾讯云 TDSQL MySQL 版 | |
| oceanbasemysql | OceanBase MySQL 模式 | |
| oceanbaseoracle | OceanBase Oracle 模式 | |
| polardboracle | 阿里云 PolarDB Oracle 兼容版 | |
| polardbx | 阿里云 PolarDB-X 分布式数据库 | |
| sqlserver | Microsoft SQL Server | |
| sybase | Sybase 数据库 | |
| singlestore | SingleStore(原 MemSQL) | |
| sqldatabase | 通用 SQL Database(内部) | |
| NoSQL | mongodb | MongoDB 文档数据库 |
| redis | Redis 数据库 | |
| OLAP / 数仓 | clickhouse | ClickHouse 列式数据库 |
| doris | Apache Doris MPP 数据库 | |
| starrocks | StarRocks MPP 数据库 | |
| selectdb | SelectDB(StarRocks 商业版) | |
| greenplum | Greenplum 数据仓库 | |
| redshift | AWS Redshift 数据仓库 | |
| dws | Data Warehouse Service(华为) | |
| ymatrix | MatrixOne 云原生数据库 | |
| adbpostgresql | AnalyticDB PostgreSQL | |
| tidb | TiDB HTAP 数据库 | |
| 大数据 / 消息队列 | hive | Apache Hive |
| kafka | Kafka 消息队列 | |
| datahub | 阿里云 DataHub | |
| 搜索 | elasticsearch | Elasticsearch 搜索引擎 |