配置DTS任务
更新时间 2026-06-16 16:52:59
最近更新时间: 2026-06-16 16:52:59
接口功能介绍
用户购买数据传输服务DTS实例后,通过配置任务的OpenApi接口,进行任务配置。
接口约束
无
URI
POST /dts/v2/open-api/instance/configureDtsJob
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | 200000001790 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dtsInstanceId | 是 | String | 实例id | dts_ins_10086 | |
| dtsJobId | 否 | Integer | 任务id | 9223372036854775807 | |
| synchronizationDirection | 否 | String | Forward 正向 Reverse 反向,默认取值Forward | Forward | |
| description | 否 | String | 描述 | 生产环境MySQL迁移任务 | |
| jobName | 是 | String | 任务名 | mysql_mig_202509 | |
| sourceEndpointType | 否 | String | 源端连接类型: EIP, RDS, ECS, VPN, VPC,枚举值:EIP, RDS, ECS, VPN, VPC | RDS | |
| sourceEndpointInstanceId | 否 | String | 源端实例id | rm-abc123xyz | |
| sourceEndpointEngine | 否 | String | 源端数据库引擎,枚举值:MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODB | MYSQL | |
| sourceEndpointRegion | 否 | String | 源端数据库实例区域 | cn-hangzhou | |
| sourceEndpointIp | 否 | String | 源端数据库实例ip | 10.12.34.56 | |
| sourceEndpointUrl | 否 | String | 源端数据库实例url | jdbc:mysql://10.12.34.56:3306 | |
| sourceEndpointPort | 否 | Integer | 源端数据库实例端口 | 3306 | |
| sourceEndpointDatabase | 否 | String | 源端数据库名,如果是oracle则是serviceName | business_db | |
| sourceEndpointUserName | 是 | String | 源端数据库用户名 | db_user | |
| sourceEndpointPassword | 是 | String | 源端数据库密码 | Pass@123456 | |
| sourceEndpointOracleSid | 否 | String | 源端ORACLE数据库SID, 选SID时必传 | ORCLCDB | |
| sourceEndpointRole | 否 | String | 枚举值:MASTER, SLAVE | MASTER | |
| sourceEndpointArchitecture | 否 | String | 枚举值:MASTER_SLAVE, SINGLE, SHARDED, REPLICA_SET, RAC | SINGLE | |
| srcAccessMode | 否 | String | 源端为RDS MYSQL时设置的读写模式 | READ_WRITE | |
| destinationEndpointType | 否 | String | 目标端连接类型: EIP, RDS, ECS, VPN, VPC,枚举值:EIP, RDS, ECS, VPN, VPC | RDS | |
| destinationEndpointInstanceId | 否 | String | 目标端实例id | rm-def456uvw | |
| destinationEndpointEngine | 否 | String | 目标端数据库引擎,枚举值:MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODB | MYSQL | |
| destinationEndpointRegion | 否 | String | 目标端数据库实例区域 | cn-shenzhen | |
| destinationEndpointIp | 否 | String | 目标端数据库实例ip | 10.98.76.54 | |
| destinationEndpointUrl | 否 | String | 目标端数据库实例url | jdbc:mysql://10.98.76.54:3306 | |
| destinationEndpointPort | 否 | Integer | 目标端数据库实例端口 | 3306 | |
| destinationEndpointDatabase | 否 | String | 目标端数据库名,如果是oracle则是serviceName | target_biz_db | |
| destinationEndpointUserName | 否 | String | 目标端数据库用户名 | target_user | |
| destinationEndpointPassword | 否 | String | 目标端数据库密码 | Target@654321 | |
| destinationEndpointOracleSid | 否 | String | 目标端ORACLE数据库SID, 选SID时必传 | ORCL | |
| destinationEndpointRole | 否 | String | 枚举值:MASTER, SLAVE | MASTER | |
| destinationEndpointArchitecture | 否 | String | 枚举值:MASTER_SLAVE, SINGLE, SHARDED, REPLICA_SET, RAC | SINGLE | |
| dstAccessMode | 否 | String | 目标端为RDS MYSQL时设置的读写模式 | READ_WRITE | |
| structureInitialization | 否 | Boolean | 是否迁移结构 | true | |
| dataInitialization | 否 | Boolean | 是否做全量快照 | true | |
| dataSynchronization | 否 | Boolean | 是否做增量同步 | true | |
| dbList | 是 | String | 迁移或者稽查的数据库对象 | db1,db2,db3 | |
| extraProperties | 否 | Object | 附加、自定义属性配置 | ExtraPropertiesInfo | |
| type | 否 | String | 任务类型:MIGRATE, SYNC, REPLICATION, SUBSCRIBE, SUB_TASK, SUB_JOB, ROW_CHECK, DATA_CHECK | MIGRATE | |
| productSize | 否 | String | 产品规格:MICRO, SMALL, STANDARD, LARGE, XLARGE | STANDARD |
表 ExtraPropertiesInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| forwardOrReverseId | 否 | Integer | 正向或反向任务id | 1001 | |
| conflictStrategy | 否 | String | 枚举值:IGNORE, OVERWRITE, TASKFAILED, REPLACE | IGNORE | |
| bilateralSync | 否 | Boolean | 是否是双向任务 | false | |
| ddlSync | 否 | Boolean | 是否同步DDL | true | |
| lowerCase | 否 | String | 目标端是否转小写: DEFAULT, LOWER, UPPER, ORIGIN,枚举值:DEFAULT, LOWER, UPPER, ORIGIN | DEFAULT | |
| forwardConflictStrategy | 否 | String | 正向冲突策略: IGNORE, OVERWRITE, TASKFAILED, REPLACE,枚举值:IGNORE, OVERWRITE, TASKFAILED, REPLACE | OVERWRITE | |
| reveresConflictStrategy | 否 | String | 反向冲突策略: IGNORE, OVERWRITE, TASKFAILED, REPLACE,枚举值:IGNORE, OVERWRITE, TASKFAILED, REPLACE | OVERWRITE | |
| pgPluginName | 否 | String | 增量同步时,pg使用的逻辑解码插件名称 | pgoutput | |
| migrateUser | 否 | Boolean | 是否迁移用户 | false | |
| projectId | 否 | String | 企业项目id | proj_001 | |
| projectName | 否 | String | 企业项目名称 | 测试项目 | |
| backup | 否 | Boolean | 是否为UDAL容灾任务 | false | |
| backupType | 否 | String | UDAL容灾任务类型,枚举值:PARTITION_LOGICAL_REPLICATION, PARTITION_RAW_REPLICATION, GLOBAL_BINLOG_LOGICAL_REPLICATION, GLOBAL_BINLOG_RAW_REPLICATION, LOGICAL_REPLICATION... | LOGICAL_REPLICATION | |
| backupInformation | 否 | Object | 容灾信息 | BackupInformation | |
| zkSync | 否 | Boolean | UDAL容灾:是否同步zk | false | |
| configSync | 否 | Boolean | UDAL容灾:是否同步配置库 | false | |
| configBio | 否 | Boolean | UDAL容灾:配置库是否双向 | false | |
| sourceOrTarget | 否 | String | 是否使用目标部署zkcdc | target | |
| userId | 否 | String | 用户id | user_123 | |
| circleTableName | 否 | String | 防循环表名,以这个优先 | circle_table | |
| rateLimiter | 否 | Object | 限速配置 | RateLimiterInfo | |
| mongoDBSource | 否 | Object | mongo源库配置 | MongoDBInformation | |
| mongoDBTarget | 否 | Object | mongo目标库配置 | MongoDBInformation | |
| mongoDBExtraProperties | 否 | Object | mongo附加属性 | MongoDBExtraProperties | |
| udalSource | 否 | Object | udal源库配置 | UdalInformation | |
| udalTarget | 否 | Object | udal目标库配置 | UdalInformation | |
| binlogPosition | 否 | Object | binlog位点 | BinlogPosition | |
| reverseDataSync | 否 | Boolean | 枚举值:无 | false | |
| zkcdcTaskId | 否 | String | zkcdc任务id | zk_task_001 | |
| subTaskType | 否 | String | 子任务类型 | sync | |
| sourceUdalRdsSetName | 否 | String | sourceUdalRdsSetName | udal_set_01 | |
| targetUdalRdsSetName | 否 | String | targetUdalRdsSetName | udal_set_02 | |
| sourceBackupNode | 否 | Object | sourceBackupNode | SourceBackupNode | |
| zkTask | 否 | Boolean | 是否是容灾zk同步任务 | false | |
| configDataBaseTask | 否 | Boolean | 是否是容灾配置库同步任务 | false | |
| destinationKafkaExtraProperties | 否 | Object | destinationKafkaExtraProperties | KafkaExtraProperties | |
| destinationDorisExtraProperties | 否 | Object | destinationDorisExtraProperties | DorisExtraProperties | |
| destinationClickHouseExtraProperties | 否 | Object | destinationClickHouseExtraProperties | ClickHouseExtraProperties | |
| sourceTiDBIncExtraProperties | 否 | Object | sourceTiDBIncExtraProperties | TiDBIncExtraProperties | |
| sourceDbSid | 否 | String | 源端为oracle时,数据库sid | ORCL | |
| targetDbSid | 否 | String | 目标端为oracle时,数据库sid | ORCL | |
| choseNodeIds | 否 | Array of Integers | 部署任务时,用户选择的某个实例下的节点id列表 | [1,2,3] | |
| srcInstanceName | 否 | String | 源端实例名称 | mysql_source | |
| targetInstanceName | 否 | String | 目标端实例名称 | mysql_target | |
| isCountCheck | 否 | Boolean | 是否行级稽查 | false | |
| checkerRatio | 否 | Integer | 内容稽查任务的抽样率 | 100 | |
| maxDiffCount | 否 | Integer | 不一致行数超过的表不再比较剩余数据 | 1000 | |
| maxRecheckTime | 否 | Integer | 内容稽查任务对不一致数据的复检次数 | 3 | |
| quickCheck | 否 | Boolean | 快速对比只对比常见的数据类型 | false | |
| correctData | 否 | Boolean | 内容稽查任务是否自动修正不一致数据 | false | |
| multiToOne | 否 | Boolean | 多到一的数据源映射下,内容稽查只比较源端存在的数据,不比较目标端多余的数据 | false | |
| transformConfig | 否 | String | ETL Transformer配置 | {} | |
| subJobOperationType | 否 | String | 枚举值:ADD, REMOVE, INIT | ADD | |
| sourceUseSSL | 否 | Boolean | 枚举值:无 | false | |
| sourceCertUrl | 否 | String | sourceCertUrl | /cert/source.crt | |
| targetUseSSL | 否 | Boolean | 枚举值:无 | false | |
| targetCertUrl | 否 | String | targetCertUrl | /cert/target.crt | |
| filterByCircleTable | 否 | Boolean | 是否采用回环表方式过滤反向数据 | false | |
| threadIdToFilter | 否 | Integer | 针对rds并且采用threadId方式过滤回环数据时,过滤该线程id的回环数据 | 12345 |
表 BackupInformation
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sourceUserId | 否 | Integer | sourceUserId | ||
| targetUserId | 否 | Integer | targetUserId | ||
| setRelation | 否 | String | setRelation | ||
| backupZkInformation | 否 | Object | UDAL容灾任务需要的zk配置信息 | BackupZkInformation | |
| configMetaInformation | 否 | Array of Objects | UDAL容灾任务需要的配置库信息 | UdalConfigDatasource | |
| configMetaDatabaseMap | 否 | Array of Strings | UDAL容灾任务需要的配置库映射信息 | - | |
| dataHostMap | 否 | Map of String | UDAL容灾任务需要的dataHost映射信息 | - | |
| rdsProdMap | 否 | Map of String | rdsProdMap | ||
| hostNameMap | 否 | Array of Objects | 数组[0]是源,[1]是目标,key是分片的ip:port,value是hostName,在原生复制时需要 | Map of String | |
| dataHostMapList | 否 | Array of Objects | 数据库域名映射 | Map of String | |
| ipToDatabasesMap | 否 | Map of String | 数据库ip到数据库映射 | ||
| wholeDatabases | 否 | Array of Strings | 整库数据库列表 | ||
| dataHostMapText | 否 | String | 数据库ip到数据库映射文本 | ||
| targetVersion | 否 | String | 目标库版本 | ||
| sourceVersion | 否 | String | 源库版本 | ||
| sourceUdalUrl | 否 | String | udal源库url | ||
| targetUdalUrl | 否 | String | udal目标库url | ||
| sourceRegionId | 否 | String | 源库资源池id | ||
| targetRegionId | 否 | String | 目标库资源池id | ||
| sourceTenantId | 否 | String | 源库租户id | ||
| sourceClusterId | 否 | String | 源库集群id | ||
| targetClusterId | 否 | String | 目标库集群id | ||
| zkcdcTaskId | 否 | String | zkcdc任务id | ||
| offsetForRecovery | 否 | String | 恢复offset | ||
| targetTenantId | 否 | String | 目标库租户id |
表 BackupZkInformation
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sourceZkUrl | 否 | String | sourceZkUrl | 127.0.0.1:2181 | |
| sourceZkNamespace | 否 | String | sourceZkNamespace | /udal/src | |
| targetZkUrl | 否 | String | targetZkUrl | 127.0.0.2:2181 | |
| targetZkNamespace | 否 | String | targetZkNamespace | /udal/dst | |
| zkCdcTaskId | 否 | String | zkCdcTaskId | zkcdc_10001 | |
| status | 否 | String | status | RUNNING | |
| dbproxyNodeId | 否 | String | dbproxyNodeId | dbp_001 | |
| sourceZookeeperId | 否 | String | sourceZookeeperId | zk_src_01 | |
| sourceUdalZkDetails | 否 | Array of Objects | sourceUdalZkDetails | UdalZkDetails | |
| sourceSecondaryNamespace | 否 | String | sourceSecondaryNamespace | /udal/src/sec | |
| targetSecondaryNamespace | 否 | String | targetSecondaryNamespace | /udal/dst/sec | |
| targetZookeeperId | 否 | String | targetZookeeperId | zk_dst_01 | |
| targetUdalZkDetails | 否 | Array of Objects | targetUdalZkDetails | UdalZkDetails |
表 UdalZkDetails
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 否 | String | id | node_001 | |
| zkId | 否 | String | zkId | zk_ins_01 | |
| host | 否 | String | host | 10.12.34.56 | |
| clientPort | 否 | String | clientPort | 2181 | |
| peerPort | 否 | String | peerPort | 2888 | |
| electPort | 否 | String | electPort | 3888 | |
| zkServerId | 否 | String | zkServerId | server.1 | |
| sshPort | 否 | String | sshPort | 22 | |
| sshUser | 否 | String | sshUser | zkadmin | |
| sshPassword | 否 | String | sshPassword | Zk@123456 | |
| deployPath | 否 | String | deployPath | /usr/local/zookeeper | |
| createTime | 否 | String | createTime | 2025-05-10 14:20:10 | |
| updateTime | 否 | String | updateTime | 2025-05-12 09:15:33 |
表 UdalConfigDatasource
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ip | 否 | String | ip | 192.168.10.12 | |
| port | 否 | String | port | 3306 | |
| url | 否 | String | url | jdbc:mysql://192.168.10.12:3306 | |
| username | 否 | String | username | root | |
| password | 否 | String | password | Udal@Pass123 |
表 RateLimiterInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| fullRps | 否 | Integer | 全量迁移每秒限制迁移多少行 | 10000 | |
| fullBps | 否 | Integer | 全量迁移每秒限制迁移多少字节 | 52428800 | |
| incRps | 否 | Integer | 增量迁移每秒限制迁移多少行 | 20000 | |
| incBps | 否 | Integer | 增量迁移每秒限制迁移多少字节 | 104857600 | |
| rateLimiterEnable | 否 | Boolean | 是否开启全量限流 | true | |
| incRateLimiterEnable | 否 | Boolean | 是否开启增量限流 | false |
表 MongoDBInformation
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| mongoDBNodeList | 否 | Array of Objects | mongoDBNodeList | MongoDBNode | |
| userNameShard | 否 | String | userNameShard | admin | |
| passwordShard | 否 | String | passwordShard | Admin@123 | |
| shardUrlList | 否 | Array of Strings | shardUrlList | ["mongodb://192.168.1.10:27017","mongodb://192.168.1.11:27017"] | |
| dbUrl | 否 | String | dbUrl | mongodb://192.168.1.10:27017,192.168.1.11:27017/admin | |
| directConnection | 否 | Boolean | 是否直连副本集单一节点 | false | |
| mongoDBSchemaType | 否 | String | mongoDb 的架构类型:SINGLE, REPLICASET, SHARDING,枚举值:SINGLE, REPLICASET, SHARDING | REPLICASET | |
| authDbName | 否 | String | MongoDB的鉴权数据库 | admin | |
| replicaSetName | 否 | String | 副本集名称 | rs0 |
表 MongoDBNode
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ip | 否 | String | ip | 192.168.1.10 | |
| writePort | 否 | Integer | writePort | 27017 | |
| readPort | 否 | Integer | readPort | 27017 | |
| nodeType | 否 | String | nodeType | PRIMARY | |
| hostType | 否 | String | hostType | SHARD |
表 MongoDBExtraProperties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| migTag | 否 | Boolean | 是否迁移shardTag | false | |
| captureMode | 否 | String | 增量获取方式 OPLOG, CHANGESTREAM, AGGREGATION_OPLOG,枚举值:OPLOG, CHANGESTREAM, AGGREGATION_OPLOG | OPLOG | |
| userDefinedTimestamp | 否 | String | 自定义启动时间 | 1735689600000 |
表 UdalInformation
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| shardDbInfo | 否 | Array of Objects | shardDbInfo | ShardDbInfo | |
| useSsl | 否 | Boolean | useSsl | false | |
| certUrl | 否 | String | certUrl | /cert/udal_client.crt | |
| isPrimary | 否 | Boolean | isPrimary | true | |
| shardDbSamePwd | 否 | Boolean | shardDbSamePwd | false | |
| useMapIp | 否 | Boolean | useMapIp | true | |
| principal | 否 | String | principal | udal@TEST.COM | |
| clusterId | 否 | String | clusterId | udal_cluster_01 | |
| tenantId | 否 | String | tenantId | tenant_202501 | |
| userId | 否 | Integer | userId | 1008611 | |
| sourceBackupNode | 否 | Object | sourceBackupNode | SourceBackupNode | |
| udalRdsSetName | 否 | String | udalRdsSetName | udal_sz_set | |
| groupId | 否 | String | groupId | group_0001 | |
| groupName | 否 | String | groupName | sz_biz_group | |
| regionId | 否 | String | regionId | cn-shenzhen | |
| zkUrl | 否 | String | zkUrl | 127.0.0.1:2181 | |
| zkNamespace | 否 | String | zkNamespace | /udal/main | |
| zookeeperId | 否 | String | zookeeperId | zk_001 | |
| udalZkDetails | 否 | Array of Objects | udalZkDetails | UdalZkDetails | |
| secondaryNamespace | 否 | String | secondaryNamespace | /udal/secondary | |
| endpointType | 否 | String | 枚举值:EIP, RDS, ECS, VPN, VPC | RDS | |
| endpointInstanceId | 否 | String | endpointInstanceId | rm-bp1xxxxxx | |
| endpointEngine | 否 | String | 枚举值:MYSQL, ALISQL, ORACLE, UDAL, KAFKA... | UDAL | |
| endpointRegion | 否 | String | endpointRegion | cn-shenzhen | |
| endpointIp | 否 | String | endpointIp | 192.168.10.22 | |
| endpointPort | 否 | Integer | endpointPort | 3306 | |
| endpointDatabase | 否 | String | endpointDatabase | udal_meta | |
| endpointUserName | 否 | String | endpointUserName | root | |
| endpointPassword | 否 | String | endpointPassword | Udal@Pass123 | |
| configDatabase | 否 | String | configDatabase | config_db | |
| version | 否 | String | version | 3.1.2 | |
| udalConsoleUrl | 否 | String | udalConsoleUrl | http://udal-sz.xxx.com | |
| dbproxyNodeId | 否 | String | dbproxyNodeId | dbproxy_001 |
表 BinlogPosition
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| file | 否 | String | binlog文件名 | mysql-bin.000001 | |
| pos | 否 | Integer | binlog位点数值 | 156 | |
| gtids | 否 | String | gtid事务位点信息 | 41f77f98-xxxx:1-100 |
表 ShardDbInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 否 | Integer | id | 10001 | |
| shardDbUrl | 否 | String | shardDbUrl | jdbc:mysql://192.168.1.10:3306 | |
| shardMapDbUrl | 否 | String | shardMapDbUrl | jdbc:mysql://192.168.1.11:3306 | |
| agentMapDbUrl | 否 | String | agentMapDbUrl | jdbc:mysql://192.168.1.12:3306 | |
| shardDbUser | 否 | String | shardDbUser | root | |
| shardDbPwd | 否 | String | shardDbPwd | Shard@123456 | |
| sourceBackupNode | 否 | Object | sourceBackupNode | SourceBackupNode |
表 SourceBackupNode
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sourceSshHost | 否 | String | sourceSshHost | 10.0.0.100 | |
| sourceSshPort | 否 | String | sourceSshPort | 22 | |
| sourceSshUser | 否 | String | sourceSshUser | admin | |
| sourceSshPassword | 否 | String | sourceSshPassword | Ssh@Admin123 | |
| defaultsFile | 否 | String | defaultsFile | /etc/my.cnf |
表 KafkaExtraProperties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| topicName | 否 | String | topicPolicy为FOCUS时必填,数据统一投递到该topic | dts_data_sync | |
| topicPolicy | 否 | String | FOCUS:统一投递到指定的topic;AUTO:根据库或者表分别投递到不同的topic | FOCUS | |
| dataFormat | 否 | String | kafka消息格式:json、arvo | json | |
| partitionPolicy | 否 | String | 分区投递策略 | TABLE_HASH | |
| replicas | 否 | String | topic的副本数量 | 2 | |
| partitions | 否 | String | topic的分区数量 | 6 | |
| securityProtocol | 否 | String | 安全协议:SASL_PLAINTEXT、PLAINTEXT | PLAINTEXT | |
| saslMechanism | 否 | String | 使用SASL_PLAINTEXT协议时必填,SASL认证机制:GSSAPI,PLAIN | PLAIN | |
| krb5FileName | 否 | String | kerberos服务的配置文件,SASL_PLAINTEXT协议、GSSAPI认证机制下必填,文件在测试连接阶段已经上传到机器指定的目录下,这里只需提供上传文件时返回给前端的文件名 | krb5.conf | |
| keytabFileName | 否 | String | kafka client的keytab文件,SASL_PLAINTEXT协议、GSSAPI认证机制下必填,文件在测试连接阶段已经上传到机器指定的目录下,这里只需提供上传文件时返回给前端的文件名 | kafka.client.keytab | |
| principal | 否 | String | kafka集群的kerberos principal,SASL_PLAINTEXT协议、GSSAPI认证机制下必填 | kafka@EXAMPLE.COM | |
| saslKerberosServiceName | 否 | String | kafka集群的kerberos服务名称,SASL_PLAINTEXT协议、GSSAPI认证机制下必填 | kafka |
表 DorisExtraProperties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| tableModel | 否 | String | doris表模型,有主键模型UNIQUE、明细模型DUPLICATE、聚合模型AGGREGATE | UNIQUE |
表 ClickHouseExtraProperties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| tableEngine | 否 | String | clickhouse表引擎 | MergeTree | |
| clusterName | 否 | String | clickhouse集群名称 | ck_cluster_01 |
表 TiDBIncExtraProperties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| topicName | 否 | String | topicName | tidb_binlog_topic | |
| securityProtocol | 否 | String | securityProtocol | PLAINTEXT | |
| saslMechanism | 否 | String | saslMechanism | PLAIN | |
| userName | 否 | String | userName | kafka_user | |
| password | 否 | String | password | Kafka@123456 | |
| hostName | 否 | String | hostName | 192.168.1.100 | |
| port | 否 | String | port | 9092 | |
| principal | 否 | String | principal | tidb@EXAMPLE.COM | |
| krb5FileName | 否 | String | krb5FileName | krb5_tidb.conf | |
| keytabFileName | 否 | String | keytabFileName | tidb_client.keytab | |
| saslKerberosServiceName | 否 | String | saslKerberosServiceName | kafka |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| httpStatusCode | Integer | 状态码 | 200 | |
| errCode | String | 错误码 | SUCCESS | |
| errMessage | String | 提示信息 | 操作成功 | |
| success | Boolean | 请求是否成功 | true | |
| requestId | String | 请求id | req-20250905-0001 | |
| data | Object | 响应数据 | ConfigureDtsJobResult |
表 ConfigureDtsJobResult
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dtsJobId | Integer | dts任务id | ||
| dtsInstanceId | String | 实例id | ||
| reverseDtsJobId | Integer | 反向dts任务id |
枚举参数
无
请求示例
请求url
https://{host}/dts/v2/open-api/instance/configureDtsJob
请求头header
无
请求体body
{
"type": "SYNC",
"dtsInstanceId": "89bfe543db844389a4d4ac969411ee08",
"region": "200000002368",
"jobName": "autotest-m2mdts20260527200939",
"sourceEndpointType": "vpn",
"sourceEndpointEngine": "MYSQL",
"destinationEndpointType": "vpn",
"destinationEndpointEngine": "MYSQL",
"structureInitialization": true,
"dataInitialization": true,
"dataSynchronization": true,
"synchronizationDirection": "FORWARD",
"dbList": "{\"sync_m2m\":{\"name\":\"sync_m2m\",\"all\":true,\"ddl_op\":\"\",\"dml_op\":\"i,u,d\"},\"sync_m2m_1\":{\"name\":\"sync_m2m_1\",\"all\":true,\"ddl_op\":\"\",\"dml_op\":\"i,u,d\"},\"sync_m2m_big\":{\"name\":\"sync_m2m_big\",\"all\":true,\"ddl_op\":\"\",\"dml_op\":\"i,u,d\"}}",
"extraProperties": {
"rateLimiter": {
"rateLimiterEnable": false,
"fullRps": 0,
"fullBps": 0
},
"forwardConflictStrategy": "OVERWRITE",
"reveresConflictStrategy": "IGNORE",
"ddlSync": true,
"bilateralSync": false,
"migrateUser": false,
"reverseDataSync": true,
"synclow": "default",
"binloginfo": {
"synctacticscode": "",
"type": "Gtid",
"file": "",
"pos": "",
"gtids": ""
}
},
"lowerCase": "ORIGIN",
"sourceEndpointPort": 13049,
"sourceEndpointUserName": "root",
"sourceEndpointPassword": "l1SWawfsO/TI60t9PjUOcQ==",
"sourceEndpointIp": "192.168.0.37",
"destinationEndpointPort": 13049,
"destinationEndpointUserName": "root",
"destinationEndpointPassword": "l1SWawfsO/TI60t9PjUOcQ==",
"destinationEndpointIp": "192.168.0.67"
}
响应示例
{
"httpStatusCode": 200,
"success": true,
"requestId": "00-6a16e1bd1e17f5d40af1f9a20925cb3a-5d2bbfab33b8abd4-00",
"data": {
"dtsJobId": 383,
"dtsInstanceId": "89bfe543db844389a4d4ac969411ee08"
}
}
状态码
请参考 状态码
错误码
请参考 错误码