活动

天翼云最新优惠活动,涵盖免费试用,产品折扣等,助您降本增效!
热门活动
  • 云聚517 · 好价翼起拼 NEW 爆款云主机低至25.83元/年,参与拼团享更多优惠,拼成得额外优惠券
  • 安全隔离版OpenClaw NEW OpenClaw云服务器专属“龙虾“套餐低至1.5折起
  • 聚力AI赋能 天翼云大模型专项 大模型特惠专区·Token Plan 轻享包低至9.9元起
  • 青云志云端助力计划 NEW 一站式科研助手,海外资源安全访问平台,助力青年翼展宏图,平步青云
  • 企业出海解决方案 NEW 助力您的业务扬帆出海,通达全球!
  • 天翼云信创专区 NEW “一云多芯、一云多态”,国产化软件全面适配,国产操作系统及硬件芯片支持丰富
  • 中小企业服务商合作专区 国家云助力中小企业腾飞,高额上云补贴重磅上线
  • 云上钜惠 爆款云主机全场特惠,2核4G只要1.8折起!
  • 天翼云奖励推广计划 加入成为云推官,推荐新用户注册下单得现金奖励
免费活动
  • 免费试用中心 HOT 多款云产品免费试用,快来开启云上之旅
  • 天翼云用户体验官 NEW 您的洞察,重塑科技边界

息壤智算

领先开放的智算服务平台,提供算力、平台、数据、模型、应用“五位一体”智算服务体系,构建全流程的AI基础设施能力
AI Store
  • 算力市场
  • 模型市场
  • 应用市场
公共算力服务
  • 裸金属
  • 定制裸金属
训推服务
  • 模型开发
  • 训练任务
  • 服务部署
星辰TokenHub
  • 模型广场
  • 体验中心
  • 服务接入
应用托管
  • 应用实例
科研助手
  • 科研智能体
  • 科研服务
  • 开发机
  • 并行计算
大模型
  • DeepSeek-V4-Flash
  • GLM-5.1
  • Qwen3.5-122B-A10B
  • DeepSeek-V3.2(旗舰版)
  • GLM-5(正式版)
智算一体机
  • 智算一体机
智能体引擎
  • 智能体引擎
可信数据空间
  • 可信数据空间
模型适配专家服务
  • 模型适配专家服务
算力服务商
  • 入驻算力服务商

应用商城

天翼云精选行业优秀合作伙伴及千余款商品,提供一站式云上应用服务
进入甄选商城进入云市场进入AI Store创新解决方案公有云生态专区智云上海应用生态专区
建站工具
  • 新域名服务
  • SSL证书
  • 翼建站
企业办公
  • 安全邮箱
  • WPS 365 天翼云版
  • 天翼企业云盘(标准服务版)
灾备迁移
  • 云管家2.0
  • 翼备份(SaaS版)

定价

协助您快速了解云产品计费模式、价格详情,轻松预估上云成本
价格计算器
  • 动态测算产品价格
定价策略
  • 快速了解计费模式

合作伙伴

天翼云携手合作伙伴,共创云上生态,合作共赢
天翼云生态合作中心
  • 天翼云生态合作中心
天翼云渠道合作伙伴
  • 天翼云代理渠道合作伙伴
天翼云服务合作伙伴
  • 天翼云集成商交付能力认证
天翼云应用合作伙伴
  • 天翼云云市场合作伙伴
  • 天翼云甄选商城合作伙伴
天翼云技术合作伙伴
  • 天翼云OpenAPI中心
天翼云培训认证
  • 天翼云学堂
  • 天翼云市场商学院
天翼云合作计划
  • 云汇计划
天翼信创云专区
  • 信创云专区
  • 适配互认证

开发者

开发者相关功能入口汇聚
技术社区
  • 专栏文章
  • 互动问答
  • 技术视频
资源与工具
  • OpenAPI中心
培训与认证
  • 天翼云学堂
  • 天翼云认证
开源社区
  • 魔乐社区
  • OpenTeleDB

支持与服务

为您提供全方位支持与服务,全流程技术保障,助您轻松上云,安全无忧
文档与工具
  • 文档中心
  • 新手上云
  • 自助服务
  • OpenAPI中心
定价
  • 价格计算器
  • 定价策略
基础服务
  • 售前咨询
  • 在线支持
  • 在线支持
  • 工单服务
  • 服务保障
  • 会员中心
增值服务
  • 红心服务
  • 首保服务
  • 客户支持计划
  • 专家技术服务
  • 备案管家
我要反馈
  • 建议与反馈
  • 用户体验官
信息公告
  • 客户公告

了解天翼云

天翼云秉承央企使命,致力于成为数字经济主力军,投身科技强国伟大事业,为用户提供安全、普惠云服务
品牌介绍
  • 关于天翼云
  • 智算云
  • 天翼云4.0
  • 新闻资讯
  • 天翼云APP
基础设施
  • 全球基础设施
  • 信任中心
最佳实践
  • 精选案例
  • 超级探访
  • 云杂志
  • 分析师和白皮书
  • 天翼云·创新直播间
市场活动
  • 2026智能云生态大会
  • 2025智能云生态大会
  • 2024智算云生态大会
  • 2023云生态大会
  • 2022云生态大会
  • 天翼云中国行
天翼云
  • 活动
  • 息壤智算
  • 产品
  • 解决方案
  • 应用商城
  • 定价
  • 合作伙伴
  • 开发者
  • 支持与服务
  • 了解天翼云
      • 文档
      • 控制中心
      • 备案
      • 管理中心
      文档中心

      数据传输服务DTS

      数据传输服务DTS

      • 数据传输服务DTS

      无数据

        • 产品公告
        • 【协议变更】《天翼云数据传输服务DTS版服务等级协议》更新通知
        • 产品动态
        • 产品概述
        • 什么是数据传输服务
        • 支持的数据库
        • 产品优势
        • 技术架构和功能原理
        • 功能特性
        • 规格说明
        • 术语解释
        • 访问数据传输服务
        • 安全
        • DTS如何保护用户的数据
        • 监控安全风险
        • 故障恢复
        • 审计日志
        • 权限管理
        • 主子账号和IAM权限管理
        • 企业项目迁移
        • 相关服务
        • 计费说明
        • 计费项
        • 计费模式
        • 按需计费
        • 包年/包月
        • 优惠政策
        • 续订
        • 到期与欠费
        • 退订
        • 快速入门
        • 准备工作概览
        • 注册天翼云账号并完成实名认证
        • 本地数据库到天翼云
        • 通过公网网络接入天翼云
        • 其他云数据库到天翼云
        • 通过公网网络接入天翼云
        • 阿里云MongoDB到天翼云DDS数据库的网络准备
        • 天翼云数据库到天翼云
        • 同VPC通过VPC网络接入天翼云
        • 同资源池不同VPC,通过对等连接接入天翼云
        • 不同资源池通过公网网络接入天翼云
        • 天翼云ECS自建数据库到天翼云
        • 同VPC通过VPC网络接入天翼云
        • 同资源池不同VPC,通过对等连接接入天翼云
        • 不同资源池通过公网网络接入天翼云
        • 用户指南
        • 数据迁移
        • 迁移方案概览
        • 入云
        • 将MySQL迁移到MySQL
        • 将MySQL迁移到PostgreSQL
        • 将MySQL迁移到ClickHouse
        • 将PostgreSQL迁移到PostgreSQL
        • 将PostgreSQL迁移到MySQL
        • 将DDS/MongoDB副本集迁移到DDS/MongoDB副本集
        • 将DDS/MongoDB副本集迁移到DDS/MongoDB分片集群
        • 将DDS/MongoDB分片集群迁移到DDS/MongoDB分片集群
        • 将SQL Server迁移到SQL Server
        • 订购、续订、退订
        • 订购数据迁移实例
        • 续订数据迁移实例
        • 退订数据迁移实例
        • 实例配置和实例编辑
        • 配置迁移实例
        • 编辑迁移实例
        • 迁移对象管理
        • 对象名映射
        • 查看映射关系
        • 实例管理
        • 查看迁移进度
        • 查看迁移信息
        • 查看迁移日志
        • 使用数据稽查功能对比迁移项
        • 查看迁移详情
        • 生命周期管理
        • 实例状态说明
        • 开始/续传迁移实例
        • 暂停迁移实例
        • 监控告警
        • 性能监控
        • 告警配置和查看
        • 标签管理
        • 连接诊断
        • 数据同步
        • 同步方案概览
        • 入云
        • 将MySQL同步到MySQL
        • 将MySQL同步到PostgreSQL
        • MySQL实例间的双向同步
        • 将PostgreSQL同步到PostgreSQL
        • PostgreSQL实例间的双向同步
        • 将SQL Server同步到SQL Server
        • 订购、续订、退订
        • 实例配置和实例编辑
        • 配置同步实例
        • 编辑同步实例
        • 同步对象管理
        • 实例管理
        • 查看同步进度
        • 查看同步信息
        • 查看同步日志
        • 使用数据稽查功能对比同步项
        • 查看同步详情
        • 生命周期管理
        • 实例状态说明
        • 开始/续传同步实例
        • 暂停同步实例
        • 监控告警
        • 标签管理
        • 连接诊断
        • 修改同步对象
        • 连接管理
        • 限速设置
        • 日志管理
        • 查看操作日志
        • 查看云审计日志
        • 最佳实践
        • 最佳实践汇总
        • 其他云MySQL迁移到RDS for MySQL
        • 概述
        • 操作流程
        • 创建VPC和安全组
        • 创建RDS for MySQL实例
        • 其他云MySQL实例准备
        • 本地MySQL迁移到RDS for MySQL
        • 概述
        • 操作流程
        • 其他云PostgreSQL迁移到RDS for PostgreSQL
        • 概述
        • 操作流程
        • 本地PostgreSQL迁移到RDS for PostgreSQL
        • 概述
        • 操作流程
        • 常见问题
        • 产品咨询类
        • 网络安全类
        • 权限类
        • 数据迁移类
        • 数据同步类
        • 数据对比类
        • 通用操作类
        • 计费类
        • 时延类
        • 安全白皮书
        • DTS安全白皮书
        • API参考
        • API使用说明
        • API概览
        • 概述
        • 终端节点
        • 概览
        • 状态码
        • API
        • 2026-06-30 版本
        • 标签管理
        • 删除标签
        • 查询DTS实例的所有标签
        • 查询标签键对应的所有值
        • 查询标签键
        • 查询标签
        • 创建标签
        • 解绑并删除标签
        • 解绑标签
        • 查询标签关联对象
        • 绑定标签
        • DTS任务管理
        • 查询同zkcdcTaskId的容灾任务
        • 手工执行结构迁移SQL
        • 跳过迁移对象
        • 跳过DTS任务预检查
        • 一键反向
        • 容灾切换
        • 修改DTS任务的同步对象
        • 修改DTS任务的任务名
        • 修改DTS任务的db密码
        • 统计DTS任务的大盘
        • 开始用户对比
        • 开始对象对比
        • 查询DTS校验任务列表
        • 查询DTS校验任务结果
        • 配置并异步启动DTS稽查任务
        • 查询Dts子任务同步信息
        • 查询DTS任务的监控指标
        • 统计DTS任务迁移表的信息
        • 查询DTS任务操作记录
        • 查询DTS任务执行时间线
        • 查询DTS任务同步信息
        • 查询DTS任务子模块执行详情
        • 查询DTS任务的详情
        • 根据实例id查询DTS任务
        • 批量释放DTS任务
        • 批量完成DTS任务
        • 批量停止DTS任务
        • 批量启动DTS任务
        • 批量执行DTS任务的预检查
        • 释放DTS任务
        • 重置DTS任务
        • 配置DTS任务
        • 执行DTS任务的预检查
        • 查询DTS任务预检查执行详情
        • 启动DTS任务
        • 停止DTS任务
        • 重启DTS任务
        • 完成DTS任务
        • 获取DTS任务列表
        • 获取DTS实例列表
        • 提交并异步启动DTS稽查任务
        • 批量重置DTS任务
        • 2023-07-27
        • 告警规则管理
        • 查询告警规则列表
        • 修改告警规则
        • 创建告警规则
        • 查询所有的告警项
        • 标签管理
        • 解绑标签
        • 查询标签键对应的所有值
        • 查询标签
        • 创建标签
        • 查询DTS实例的所有标签
        • DTS任务管理
        • 查询DTS任务列表及各任务执行详情
        • 启动DTS任务
        • 配置DTS任务
        • 修改DTS任务名称
        • 结束DTS任务
        • 查询DTS任务详情
        • 暂停DTS任务
        • 修改DTS任务源或目标库的账号密码
        • 查询DTS任务的子任务执行详情
        • 释放DTS任务
        • 故障排除
        • 预检查不通过修复方法
        • MySQL迁移/同步到MySQL
        • PostgreSQL迁移/同步到PostgreSQL
        • 将DDS/MongoDB迁移到DDS/MongoDB
        • 将SQL Server迁移/同步到SQL Server
        • 失败案例
        • 失败案例总览
        • 配置任务案例
        • 待迁移对象数目超过限制值(超过了最大上限)
        • 结构迁移/同步案例
        • 待迁移的对象在目标库已存在(xxx already exists)
        • 依赖的对象不存在(xxx does not exist)
        • 字段无效的默认值(Invalid default value for xxx)
        • 全量迁移/同步案例
        • 初始化目标表错误(getColumnList error)
        • 目标库处于只读状态(super-read-only)
        • 目标库磁盘空间不足(No space left on device)
        • 目标库磁盘空间不足(The table xxx is full)
        • 目标库锁异常(Lock wait timeout exceeded)
        • 内存溢出(OutOfMemoryError)
        • 数据库连接失败(Communications link failure)
        • 数据库连接数太多(Too many connections)
        • 增量迁移/同步案例
        • DML同步报表不存在的错误(Table xxx doesn't exist)
        • 插入数据字段不存在(unknown column 'xxx' in field list)
        • 增量DDL同步错误(Table xxx already exists)
        • 增量node未启动(no live node)
        • 增量拉取数据IO错误(EOF encountered)
        • 相关协议
        • 服务条款
          无相关产品

          本页目录

          帮助中心 数据传输服务DTS API参考 API 2026-06-30 版本 DTS任务管理 配置DTS任务
          配置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资源池id200000001790

          请求体body参数

          参数是否必填参数类型说明示例下级对象
          dtsInstanceId是String实例iddts_ins_10086
          dtsJobId否Integer任务id9223372036854775807
          synchronizationDirection否StringForward 正向 Reverse 反向,默认取值ForwardForward
          description否String描述生产环境MySQL迁移任务
          jobName是String任务名mysql_mig_202509
          sourceEndpointType否String源端连接类型: EIP, RDS, ECS, VPN, VPC,枚举值:EIP, RDS, ECS, VPN, VPCRDS
          sourceEndpointInstanceId否String源端实例idrm-abc123xyz
          sourceEndpointEngine否String源端数据库引擎,枚举值:MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODBMYSQL
          sourceEndpointRegion否String源端数据库实例区域cn-hangzhou
          sourceEndpointIp否String源端数据库实例ip10.12.34.56
          sourceEndpointUrl否String源端数据库实例urljdbc:mysql://10.12.34.56:3306
          sourceEndpointPort否Integer源端数据库实例端口3306
          sourceEndpointDatabase否String源端数据库名,如果是oracle则是serviceNamebusiness_db
          sourceEndpointUserName是String源端数据库用户名db_user
          sourceEndpointPassword是String源端数据库密码Pass@123456
          sourceEndpointOracleSid否String源端ORACLE数据库SID, 选SID时必传ORCLCDB
          sourceEndpointRole否String枚举值:MASTER, SLAVEMASTER
          sourceEndpointArchitecture否String枚举值:MASTER_SLAVE, SINGLE, SHARDED, REPLICA_SET, RACSINGLE
          srcAccessMode否String源端为RDS MYSQL时设置的读写模式READ_WRITE
          destinationEndpointType否String目标端连接类型: EIP, RDS, ECS, VPN, VPC,枚举值:EIP, RDS, ECS, VPN, VPCRDS
          destinationEndpointInstanceId否String目标端实例idrm-def456uvw
          destinationEndpointEngine否String目标端数据库引擎,枚举值:MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODBMYSQL
          destinationEndpointRegion否String目标端数据库实例区域cn-shenzhen
          destinationEndpointIp否String目标端数据库实例ip10.98.76.54
          destinationEndpointUrl否String目标端数据库实例urljdbc:mysql://10.98.76.54:3306
          destinationEndpointPort否Integer目标端数据库实例端口3306
          destinationEndpointDatabase否String目标端数据库名,如果是oracle则是serviceNametarget_biz_db
          destinationEndpointUserName否String目标端数据库用户名target_user
          destinationEndpointPassword否String目标端数据库密码Target@654321
          destinationEndpointOracleSid否String目标端ORACLE数据库SID, 选SID时必传ORCL
          destinationEndpointRole否String枚举值:MASTER, SLAVEMASTER
          destinationEndpointArchitecture否String枚举值:MASTER_SLAVE, SINGLE, SHARDED, REPLICA_SET, RACSINGLE
          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_CHECKMIGRATE
          productSize否String产品规格:MICRO, SMALL, STANDARD, LARGE, XLARGESTANDARD

          表 ExtraPropertiesInfo

          参数是否必填参数类型说明示例下级对象
          forwardOrReverseId否Integer正向或反向任务id1001
          conflictStrategy否String枚举值:IGNORE, OVERWRITE, TASKFAILED, REPLACEIGNORE
          bilateralSync否Boolean是否是双向任务false
          ddlSync否Boolean是否同步DDLtrue
          lowerCase否String目标端是否转小写: DEFAULT, LOWER, UPPER, ORIGIN,枚举值:DEFAULT, LOWER, UPPER, ORIGINDEFAULT
          forwardConflictStrategy否String正向冲突策略: IGNORE, OVERWRITE, TASKFAILED, REPLACE,枚举值:IGNORE, OVERWRITE, TASKFAILED, REPLACEOVERWRITE
          reveresConflictStrategy否String反向冲突策略: IGNORE, OVERWRITE, TASKFAILED, REPLACE,枚举值:IGNORE, OVERWRITE, TASKFAILED, REPLACEOVERWRITE
          pgPluginName否String增量同步时,pg使用的逻辑解码插件名称pgoutput
          migrateUser否Boolean是否迁移用户false
          projectId否String企业项目idproj_001
          projectName否String企业项目名称测试项目
          backup否Boolean是否为UDAL容灾任务false
          backupType否StringUDAL容灾任务类型,枚举值:PARTITION_LOGICAL_REPLICATION, PARTITION_RAW_REPLICATION, GLOBAL_BINLOG_LOGICAL_REPLICATION, GLOBAL_BINLOG_RAW_REPLICATION, LOGICAL_REPLICATION...LOGICAL_REPLICATION
          backupInformation否Object容灾信息BackupInformation
          zkSync否BooleanUDAL容灾:是否同步zkfalse
          configSync否BooleanUDAL容灾:是否同步配置库false
          configBio否BooleanUDAL容灾:配置库是否双向false
          sourceOrTarget否String是否使用目标部署zkcdctarget
          userId否String用户iduser_123
          circleTableName否String防循环表名,以这个优先circle_table
          rateLimiter否Object限速配置RateLimiterInfo
          mongoDBSource否Objectmongo源库配置MongoDBInformation
          mongoDBTarget否Objectmongo目标库配置MongoDBInformation
          mongoDBExtraProperties否Objectmongo附加属性MongoDBExtraProperties
          udalSource否Objectudal源库配置UdalInformation
          udalTarget否Objectudal目标库配置UdalInformation
          binlogPosition否Objectbinlog位点BinlogPosition
          reverseDataSync否Boolean枚举值:无false
          zkcdcTaskId否Stringzkcdc任务idzk_task_001
          subTaskType否String子任务类型sync
          sourceUdalRdsSetName否StringsourceUdalRdsSetNameudal_set_01
          targetUdalRdsSetName否StringtargetUdalRdsSetNameudal_set_02
          sourceBackupNode否ObjectsourceBackupNodeSourceBackupNode
          zkTask否Boolean是否是容灾zk同步任务false
          configDataBaseTask否Boolean是否是容灾配置库同步任务false
          destinationKafkaExtraProperties否ObjectdestinationKafkaExtraPropertiesKafkaExtraProperties
          destinationDorisExtraProperties否ObjectdestinationDorisExtraPropertiesDorisExtraProperties
          destinationClickHouseExtraProperties否ObjectdestinationClickHouseExtraPropertiesClickHouseExtraProperties
          sourceTiDBIncExtraProperties否ObjectsourceTiDBIncExtraPropertiesTiDBIncExtraProperties
          sourceDbSid否String源端为oracle时,数据库sidORCL
          targetDbSid否String目标端为oracle时,数据库sidORCL
          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否StringETL Transformer配置{}
          subJobOperationType否String枚举值:ADD, REMOVE, INITADD
          sourceUseSSL否Boolean枚举值:无false
          sourceCertUrl否StringsourceCertUrl/cert/source.crt
          targetUseSSL否Boolean枚举值:无false
          targetCertUrl否StringtargetCertUrl/cert/target.crt
          filterByCircleTable否Boolean是否采用回环表方式过滤反向数据false
          threadIdToFilter否Integer针对rds并且采用threadId方式过滤回环数据时,过滤该线程id的回环数据12345

          表 BackupInformation

          参数是否必填参数类型说明示例下级对象
          sourceUserId否IntegersourceUserId
          targetUserId否IntegertargetUserId
          setRelation否StringsetRelation
          backupZkInformation否ObjectUDAL容灾任务需要的zk配置信息BackupZkInformation
          configMetaInformation否Array of ObjectsUDAL容灾任务需要的配置库信息UdalConfigDatasource
          configMetaDatabaseMap否Array of StringsUDAL容灾任务需要的配置库映射信息-
          dataHostMap否Map of StringUDAL容灾任务需要的dataHost映射信息-
          rdsProdMap否Map of StringrdsProdMap
          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否Stringudal源库url
          targetUdalUrl否Stringudal目标库url
          sourceRegionId否String源库资源池id
          targetRegionId否String目标库资源池id
          sourceTenantId否String源库租户id
          sourceClusterId否String源库集群id
          targetClusterId否String目标库集群id
          zkcdcTaskId否Stringzkcdc任务id
          offsetForRecovery否String恢复offset
          targetTenantId否String目标库租户id

          表 BackupZkInformation

          参数是否必填参数类型说明示例下级对象
          sourceZkUrl否StringsourceZkUrl127.0.0.1:2181
          sourceZkNamespace否StringsourceZkNamespace/udal/src
          targetZkUrl否StringtargetZkUrl127.0.0.2:2181
          targetZkNamespace否StringtargetZkNamespace/udal/dst
          zkCdcTaskId否StringzkCdcTaskIdzkcdc_10001
          status否StringstatusRUNNING
          dbproxyNodeId否StringdbproxyNodeIddbp_001
          sourceZookeeperId否StringsourceZookeeperIdzk_src_01
          sourceUdalZkDetails否Array of ObjectssourceUdalZkDetailsUdalZkDetails
          sourceSecondaryNamespace否StringsourceSecondaryNamespace/udal/src/sec
          targetSecondaryNamespace否StringtargetSecondaryNamespace/udal/dst/sec
          targetZookeeperId否StringtargetZookeeperIdzk_dst_01
          targetUdalZkDetails否Array of ObjectstargetUdalZkDetailsUdalZkDetails

          表 UdalZkDetails

          参数是否必填参数类型说明示例下级对象
          id否Stringidnode_001
          zkId否StringzkIdzk_ins_01
          host否Stringhost10.12.34.56
          clientPort否StringclientPort2181
          peerPort否StringpeerPort2888
          electPort否StringelectPort3888
          zkServerId否StringzkServerIdserver.1
          sshPort否StringsshPort22
          sshUser否StringsshUserzkadmin
          sshPassword否StringsshPasswordZk@123456
          deployPath否StringdeployPath/usr/local/zookeeper
          createTime否StringcreateTime2025-05-10 14:20:10
          updateTime否StringupdateTime2025-05-12 09:15:33

          表 UdalConfigDatasource

          参数是否必填参数类型说明示例下级对象
          ip否Stringip192.168.10.12
          port否Stringport3306
          url否Stringurljdbc:mysql://192.168.10.12:3306
          username否Stringusernameroot
          password否StringpasswordUdal@Pass123

          表 RateLimiterInfo

          参数是否必填参数类型说明示例下级对象
          fullRps否Integer全量迁移每秒限制迁移多少行10000
          fullBps否Integer全量迁移每秒限制迁移多少字节52428800
          incRps否Integer增量迁移每秒限制迁移多少行20000
          incBps否Integer增量迁移每秒限制迁移多少字节104857600
          rateLimiterEnable否Boolean是否开启全量限流true
          incRateLimiterEnable否Boolean是否开启增量限流false

          表 MongoDBInformation

          参数是否必填参数类型说明示例下级对象
          mongoDBNodeList否Array of ObjectsmongoDBNodeListMongoDBNode
          userNameShard否StringuserNameShardadmin
          passwordShard否StringpasswordShardAdmin@123
          shardUrlList否Array of StringsshardUrlList["mongodb://192.168.1.10:27017","mongodb://192.168.1.11:27017"]
          dbUrl否StringdbUrlmongodb://192.168.1.10:27017,192.168.1.11:27017/admin
          directConnection否Boolean是否直连副本集单一节点false
          mongoDBSchemaType否StringmongoDb 的架构类型:SINGLE, REPLICASET, SHARDING,枚举值:SINGLE, REPLICASET, SHARDINGREPLICASET
          authDbName否StringMongoDB的鉴权数据库admin
          replicaSetName否String副本集名称rs0

          表 MongoDBNode

          参数是否必填参数类型说明示例下级对象
          ip否Stringip192.168.1.10
          writePort否IntegerwritePort27017
          readPort否IntegerreadPort27017
          nodeType否StringnodeTypePRIMARY
          hostType否StringhostTypeSHARD

          表 MongoDBExtraProperties

          参数是否必填参数类型说明示例下级对象
          migTag否Boolean是否迁移shardTagfalse
          captureMode否String增量获取方式 OPLOG, CHANGESTREAM, AGGREGATION_OPLOG,枚举值:OPLOG, CHANGESTREAM, AGGREGATION_OPLOGOPLOG
          userDefinedTimestamp否String自定义启动时间1735689600000

          表 UdalInformation

          参数是否必填参数类型说明示例下级对象
          shardDbInfo否Array of ObjectsshardDbInfoShardDbInfo
          useSsl否BooleanuseSslfalse
          certUrl否StringcertUrl/cert/udal_client.crt
          isPrimary否BooleanisPrimarytrue
          shardDbSamePwd否BooleanshardDbSamePwdfalse
          useMapIp否BooleanuseMapIptrue
          principal否Stringprincipaludal@TEST.COM
          clusterId否StringclusterIdudal_cluster_01
          tenantId否StringtenantIdtenant_202501
          userId否IntegeruserId1008611
          sourceBackupNode否ObjectsourceBackupNodeSourceBackupNode
          udalRdsSetName否StringudalRdsSetNameudal_sz_set
          groupId否StringgroupIdgroup_0001
          groupName否StringgroupNamesz_biz_group
          regionId否StringregionIdcn-shenzhen
          zkUrl否StringzkUrl127.0.0.1:2181
          zkNamespace否StringzkNamespace/udal/main
          zookeeperId否StringzookeeperIdzk_001
          udalZkDetails否Array of ObjectsudalZkDetailsUdalZkDetails
          secondaryNamespace否StringsecondaryNamespace/udal/secondary
          endpointType否String枚举值:EIP, RDS, ECS, VPN, VPCRDS
          endpointInstanceId否StringendpointInstanceIdrm-bp1xxxxxx
          endpointEngine否String枚举值:MYSQL, ALISQL, ORACLE, UDAL, KAFKA...UDAL
          endpointRegion否StringendpointRegioncn-shenzhen
          endpointIp否StringendpointIp192.168.10.22
          endpointPort否IntegerendpointPort3306
          endpointDatabase否StringendpointDatabaseudal_meta
          endpointUserName否StringendpointUserNameroot
          endpointPassword否StringendpointPasswordUdal@Pass123
          configDatabase否StringconfigDatabaseconfig_db
          version否Stringversion3.1.2
          udalConsoleUrl否StringudalConsoleUrlhttp://udal-sz.xxx.com
          dbproxyNodeId否StringdbproxyNodeIddbproxy_001

          表 BinlogPosition

          参数是否必填参数类型说明示例下级对象
          file否Stringbinlog文件名mysql-bin.000001
          pos否Integerbinlog位点数值156
          gtids否Stringgtid事务位点信息41f77f98-xxxx:1-100

          表 ShardDbInfo

          参数是否必填参数类型说明示例下级对象
          id否Integerid10001
          shardDbUrl否StringshardDbUrljdbc:mysql://192.168.1.10:3306
          shardMapDbUrl否StringshardMapDbUrljdbc:mysql://192.168.1.11:3306
          agentMapDbUrl否StringagentMapDbUrljdbc:mysql://192.168.1.12:3306
          shardDbUser否StringshardDbUserroot
          shardDbPwd否StringshardDbPwdShard@123456
          sourceBackupNode否ObjectsourceBackupNodeSourceBackupNode

          表 SourceBackupNode

          参数是否必填参数类型说明示例下级对象
          sourceSshHost否StringsourceSshHost10.0.0.100
          sourceSshPort否StringsourceSshPort22
          sourceSshUser否StringsourceSshUseradmin
          sourceSshPassword否StringsourceSshPasswordSsh@Admin123
          defaultsFile否StringdefaultsFile/etc/my.cnf

          表 KafkaExtraProperties

          参数是否必填参数类型说明示例下级对象
          topicName否StringtopicPolicy为FOCUS时必填,数据统一投递到该topicdts_data_sync
          topicPolicy否StringFOCUS:统一投递到指定的topic;AUTO:根据库或者表分别投递到不同的topicFOCUS
          dataFormat否Stringkafka消息格式:json、arvojson
          partitionPolicy否String分区投递策略TABLE_HASH
          replicas否Stringtopic的副本数量2
          partitions否Stringtopic的分区数量6
          securityProtocol否String安全协议:SASL_PLAINTEXT、PLAINTEXTPLAINTEXT
          saslMechanism否String使用SASL_PLAINTEXT协议时必填,SASL认证机制:GSSAPI,PLAINPLAIN
          krb5FileName否Stringkerberos服务的配置文件,SASL_PLAINTEXT协议、GSSAPI认证机制下必填,文件在测试连接阶段已经上传到机器指定的目录下,这里只需提供上传文件时返回给前端的文件名krb5.conf
          keytabFileName否Stringkafka client的keytab文件,SASL_PLAINTEXT协议、GSSAPI认证机制下必填,文件在测试连接阶段已经上传到机器指定的目录下,这里只需提供上传文件时返回给前端的文件名kafka.client.keytab
          principal否Stringkafka集群的kerberos principal,SASL_PLAINTEXT协议、GSSAPI认证机制下必填kafka@EXAMPLE.COM
          saslKerberosServiceName否Stringkafka集群的kerberos服务名称,SASL_PLAINTEXT协议、GSSAPI认证机制下必填kafka

          表 DorisExtraProperties

          参数是否必填参数类型说明示例下级对象
          tableModel否Stringdoris表模型,有主键模型UNIQUE、明细模型DUPLICATE、聚合模型AGGREGATEUNIQUE

          表 ClickHouseExtraProperties

          参数是否必填参数类型说明示例下级对象
          tableEngine否Stringclickhouse表引擎MergeTree
          clusterName否Stringclickhouse集群名称ck_cluster_01

          表 TiDBIncExtraProperties

          参数是否必填参数类型说明示例下级对象
          topicName否StringtopicNametidb_binlog_topic
          securityProtocol否StringsecurityProtocolPLAINTEXT
          saslMechanism否StringsaslMechanismPLAIN
          userName否StringuserNamekafka_user
          password否StringpasswordKafka@123456
          hostName否StringhostName192.168.1.100
          port否Stringport9092
          principal否Stringprincipaltidb@EXAMPLE.COM
          krb5FileName否Stringkrb5FileNamekrb5_tidb.conf
          keytabFileName否StringkeytabFileNametidb_client.keytab
          saslKerberosServiceName否StringsaslKerberosServiceNamekafka

          响应参数

          参数参数类型说明示例下级对象
          httpStatusCodeInteger状态码200
          errCodeString错误码SUCCESS
          errMessageString提示信息操作成功
          successBoolean请求是否成功true
          requestIdString请求idreq-20250905-0001
          dataObject响应数据ConfigureDtsJobResult

          表 ConfigureDtsJobResult

          参数参数类型说明示例下级对象
          dtsJobIdIntegerdts任务id
          dtsInstanceIdString实例id
          reverseDtsJobIdInteger反向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"
              }
          }
          

          状态码

          请参考 状态码

          错误码

          请参考 错误码

          文档反馈

          建议您登录后反馈,可在建议与反馈里查看问题处理进度

          鼠标选中文档,精准反馈问题

          选中存在疑惑的内容,即可快速反馈问题,我们会跟进处理

          知道了

          上一篇 :  重置DTS任务
          下一篇 :  执行DTS任务的预检查
          搜索 关闭
          ©2026 天翼云科技有限公司版权所有 增值电信业务经营许可证A2.B1.B2-20090001
          公司地址:北京市东城区青龙胡同甲1号、3号2幢2层205-32室
          备案 京公网安备11010802043424号 京ICP备 2021034386号
          ©2026天翼云科技有限公司版权所有
          京ICP备 2021034386号
          备案 京公网安备11010802043424号
          增值电信业务经营许可证A2.B1.B2-20090001
          用户协议 隐私政策 法律声明