专线迁移MongoDB分片集迁移到云数据库MongoDB分片集

数据传输服务 DTS

  • 任务管理
    • 任务限速
    • 修改迁移任务的当前位点
    • 查看任务进度
    • 创建类似任务
    • 一键反向
    • 管理任务对象
      • 同步Online DDL
      • 迁移数据库账号
      • 修改同步对象
      • 传输对象范围
      • 设置过滤条件
      • 库表列名映射
    • 生命周期
      • 结束任务
      • 删除任务
      • 暂停任务
      • 变更任务链路规格
      • 启动任务
  • API3.0
    • 调用说明
    • API概览
    • 目录
    • 数据传输任务
      • 结束任务
      • 更新任务名称
      • 暂停任务
      • 查询前置检查结果
      • 释放任务
      • 修改同步对象
      • 修改同步对象记录
      • 创建任务
      • 前置检查
      • 强制跳过预检查
      • 查询任务列表
      • 变更链路规格
      • 配置任务
      • 查询任务信息
      • 启动任务
      • demo
        • 专线迁移Redis Cluster迁移到云数据库Redis企业集群版-一键反向
        • 专线迁移MongoDB副本集迁移到云数据库MongoDB副本集
        • 专线迁移Redis Cluster迁移到云数据库Redis标准版
        • 专线迁移Redis Cluster迁移到云数据库Redis标准版-数据校验
        • 专线迁移Redis Cluster迁移到云数据库Redis企业集群版-数据校验
        • 公网sql迁移到公网kafka
        • 专线迁移Redis标准版迁移到云数据库Redis标准版-一键反向
        • 专线迁移的MongoDB分片集迁移到云数据库MongoDB分片集-数据校验
        • 专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-一键反向
        • 专线迁移MySQL迁移到云数据库RDS-一键反向
        • 专线迁移的Redis标准版迁移到云数据库Redis标准版-数据校验
        • 专线迁移MySQL迁移到云数据库RDS-数据校验
        • 专线迁移MongoDB分片集迁移到云数据库MongoDB分片集
        • 专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-数据校验
        • 专线迁移MySQL迁移到云数据库RDS
        • 专线迁移Redis Cluster迁移到云数据库Redis企业集群版
        • 专线迁移Redis标准版迁移到云数据库Redis标准版
      • 其他
        • 一键反向查询前置检查结果
        • 展示授权白名单
        • 一键反向延迟检查
        • 获取订单状态
        • 配置一键反向
        • 查询vpc列表
        • 查询MySQL实例拥有的账号列表
        • 绑定&解除标签
        • 查询可用区列表
        • 检查数据库连通性
        • 一键反向
      • 数据校验
        • 查询数据校验任务列表
        • 数据校验任务启动
        • 创建数据校验任务
        • 配置数据校验任务
        • 停止校验
        • 查看数据校验比对结果
        • 数据校验前置检查
        • 查看数据校验任务信息
  • 监控报警
    • 查看任务监控
    • 设置报警策略
  • 产品计费
    • 计费概述
    • 到期或欠费说明
    • 计费方式
    • 变更和退订说明
  • 数据校验
    • 配置数据校验
    • 查看数据校验
    • 数据校验概述
  • Java_SDK
    • SDK下载页
    • 安装-DTS-Java-SDK
    • 使用数据订阅SDK
    • SDK接口简介
    • SDK下载
    • 概述
  • 快速入门
    • 购买流程
    • 数据迁移操作指导
    • 配置迁移任务
  • 典型实践
    • 使用NimoShake将Amazon DynamoDB迁移至百度云DocDB
    • 不同库名间的数据同步
    • 获取主账号ID
    • 使用DTS实现目标端为Elasticsearch的数据迁移
    • 使用DTS实现MySQL数据拆分
    • 数据库迁移上云
    • 业务切换流程
    • DTS支持专线迁移
    • DTS支持专线迁移(新)
    • 修改RDS MySQL参数提升迁移性能
    • MySQL实例的双向同步
  • 准备工作
    • 自建MySQL创建账号并设置binlog
    • 迁移评估
      • 源端MySQL迁移评估
    • 网络准备
      • 网络准备概述
      • VPC接入
      • 添加DTS服务IP白名单
      • 本地IDC接入百度智能云
        • VPN接入
        • 专线接入
        • 公网接入
    • 访问控制
      • 子用户权限管理
  • 产品简介
    • 支持的数据流
    • 功能概览
    • 基本概念
    • 产品优势
    • 架构原理
    • 应用场景
    • 什么是数据库传输服务DTS
    • 链路规格说明
  • 数据迁移
    • 跨账号迁移云数据库实例
    • 迁移方案概览
    • TiDB为源的迁移
      • 自建TiDB迁移至GaiaDB
    • Oracle为源的迁移
      • 自建Oracle迁移至RDS MySQL
    • GaiaDB为源的迁移
      • GaiaDB实例间的迁移
    • MySQL为源的迁移
      • 腾讯云MySQL迁移至RDS MySQL
      • RDS MySQL迁移至GaiaDB
      • 自建MySQL迁移至GaiaDB
      • 自建MySQL迁移至RDS MySQL
      • 阿里云PolarDB迁移至GaiaDB
      • RDS MySQL实例间的迁移
      • 阿里云MySQL迁移至RDS MySQL
      • MySQL迁移至Kafka
    • 异构数据库间的数据类型映射关系
      • 百度智能云DTS数据类型
      • DTS支持的数据源端
        • 将Kafka作为源端
        • 将Redis标准版作为源端
        • 将GaiaDB作为源端
        • 将Oracle作为源端
        • 将SQL Server作为源端
        • 将云上百度DRDS作为源端
        • 将MongoDB分片集作为源端
        • 将PostgreSQL作为源端
        • 将MongoDB副本集作为源端
        • 将MySQL作为源端
      • DTS支持的数据目的端
        • 将SQL Server作为目标端
        • 将Elasticsearch作为DTS目的端
        • 将GaiaDB作为目标端
        • 将Palo作为目标端
        • 将DataHub作为目标端
        • 将PostgreSQL作为目标端
        • 将MySQL作为目标端
        • 将Kafka作为DTS目标端
    • SQL Server 为源的迁移
      • 自建SQL Server迁移至RDS SQL Server
    • MongoDB为源的迁移
      • 自建MongoDB分片集迁移至DocDB MongoDB
      • DocDB MongoDB副本集迁移至DocDB MongoDB
    • Kafka为源的迁移
      • 自建Kafka迁移至消息服务 for Kafka
    • PostgreSQL为源的迁移
      • RDS PostgreSQL实例间的迁移
      • 自建PostgreSQL迁移至RDS PostgreSQL
      • AWS PostgreSQL迁移至RDS PostgreSQL
    • Redis为源的迁移
      • 使用DTS实现自建Redis标准版到百度智能云SCS for Redis标准版的数据迁移
      • 云数据库Redis实例间的迁移
      • 自建Redis迁移至云数据库Redis(含PegaDB)
    • Milvus为源的迁移
      • 自建 Milvus 迁移至向量数据库 VectorDB
  • 产品动态
    • 功能发布记录
    • 公告
      • 数据传输服务DTS支持多规格数据传输任务
      • 数据传输服务DTS任务状态升级通知
  • 预检查项
    • TiDB检查项
    • PostgreSQL检查项
    • MySQL检查项
    • Palo检查项
    • Oracle检查项
    • GaiaDB-X检查项
    • RocketMQ检查项
    • MongoDB检查项
    • Redis检查项
    • Elasticsearch检查项
    • GaiaDB检查项
    • Kafka检查项
    • 预检查不通过处理方法
      • 源库、目标库的连接数是否满足要求检查
      • 迁移表依赖的外键父表是否迁移检查
      • 目的数据库是否只读检查
      • 目的数据库的账号权限是否满足迁移要求检查
      • 目的库中表是否为空检查
      • 源库和目标库中SQL_MODE是否合法检查
      • 数据传输服务器是否能连通目的数据库检查
      • 源数据库的版本号检查
      • 源数据库的账号权限是否满足迁移要求检查
      • 迁移表是否有不支持的存储引擎检查
      • 预检查项汇总
      • 迁移表的表结构在目的库是否存在检查
      • 目的数据库待迁入的数据库是否可用检查
      • 目的库是否存在跟待迁移对象同名的结构对象检查
      • 数据传输服务器是否能连通源数据库检查
  • 服务支持
    • 相关协议
      • DTS服务等级协议SLA
    • 常见问题
      • 使用类问题
      • 数据迁移问题
      • 常见问题总览
      • 数据同步问题
所有文档
menu
没有找到结果,请重新输入

数据传输服务 DTS

  • 任务管理
    • 任务限速
    • 修改迁移任务的当前位点
    • 查看任务进度
    • 创建类似任务
    • 一键反向
    • 管理任务对象
      • 同步Online DDL
      • 迁移数据库账号
      • 修改同步对象
      • 传输对象范围
      • 设置过滤条件
      • 库表列名映射
    • 生命周期
      • 结束任务
      • 删除任务
      • 暂停任务
      • 变更任务链路规格
      • 启动任务
  • API3.0
    • 调用说明
    • API概览
    • 目录
    • 数据传输任务
      • 结束任务
      • 更新任务名称
      • 暂停任务
      • 查询前置检查结果
      • 释放任务
      • 修改同步对象
      • 修改同步对象记录
      • 创建任务
      • 前置检查
      • 强制跳过预检查
      • 查询任务列表
      • 变更链路规格
      • 配置任务
      • 查询任务信息
      • 启动任务
      • demo
        • 专线迁移Redis Cluster迁移到云数据库Redis企业集群版-一键反向
        • 专线迁移MongoDB副本集迁移到云数据库MongoDB副本集
        • 专线迁移Redis Cluster迁移到云数据库Redis标准版
        • 专线迁移Redis Cluster迁移到云数据库Redis标准版-数据校验
        • 专线迁移Redis Cluster迁移到云数据库Redis企业集群版-数据校验
        • 公网sql迁移到公网kafka
        • 专线迁移Redis标准版迁移到云数据库Redis标准版-一键反向
        • 专线迁移的MongoDB分片集迁移到云数据库MongoDB分片集-数据校验
        • 专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-一键反向
        • 专线迁移MySQL迁移到云数据库RDS-一键反向
        • 专线迁移的Redis标准版迁移到云数据库Redis标准版-数据校验
        • 专线迁移MySQL迁移到云数据库RDS-数据校验
        • 专线迁移MongoDB分片集迁移到云数据库MongoDB分片集
        • 专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-数据校验
        • 专线迁移MySQL迁移到云数据库RDS
        • 专线迁移Redis Cluster迁移到云数据库Redis企业集群版
        • 专线迁移Redis标准版迁移到云数据库Redis标准版
      • 其他
        • 一键反向查询前置检查结果
        • 展示授权白名单
        • 一键反向延迟检查
        • 获取订单状态
        • 配置一键反向
        • 查询vpc列表
        • 查询MySQL实例拥有的账号列表
        • 绑定&解除标签
        • 查询可用区列表
        • 检查数据库连通性
        • 一键反向
      • 数据校验
        • 查询数据校验任务列表
        • 数据校验任务启动
        • 创建数据校验任务
        • 配置数据校验任务
        • 停止校验
        • 查看数据校验比对结果
        • 数据校验前置检查
        • 查看数据校验任务信息
  • 监控报警
    • 查看任务监控
    • 设置报警策略
  • 产品计费
    • 计费概述
    • 到期或欠费说明
    • 计费方式
    • 变更和退订说明
  • 数据校验
    • 配置数据校验
    • 查看数据校验
    • 数据校验概述
  • Java_SDK
    • SDK下载页
    • 安装-DTS-Java-SDK
    • 使用数据订阅SDK
    • SDK接口简介
    • SDK下载
    • 概述
  • 快速入门
    • 购买流程
    • 数据迁移操作指导
    • 配置迁移任务
  • 典型实践
    • 使用NimoShake将Amazon DynamoDB迁移至百度云DocDB
    • 不同库名间的数据同步
    • 获取主账号ID
    • 使用DTS实现目标端为Elasticsearch的数据迁移
    • 使用DTS实现MySQL数据拆分
    • 数据库迁移上云
    • 业务切换流程
    • DTS支持专线迁移
    • DTS支持专线迁移(新)
    • 修改RDS MySQL参数提升迁移性能
    • MySQL实例的双向同步
  • 准备工作
    • 自建MySQL创建账号并设置binlog
    • 迁移评估
      • 源端MySQL迁移评估
    • 网络准备
      • 网络准备概述
      • VPC接入
      • 添加DTS服务IP白名单
      • 本地IDC接入百度智能云
        • VPN接入
        • 专线接入
        • 公网接入
    • 访问控制
      • 子用户权限管理
  • 产品简介
    • 支持的数据流
    • 功能概览
    • 基本概念
    • 产品优势
    • 架构原理
    • 应用场景
    • 什么是数据库传输服务DTS
    • 链路规格说明
  • 数据迁移
    • 跨账号迁移云数据库实例
    • 迁移方案概览
    • TiDB为源的迁移
      • 自建TiDB迁移至GaiaDB
    • Oracle为源的迁移
      • 自建Oracle迁移至RDS MySQL
    • GaiaDB为源的迁移
      • GaiaDB实例间的迁移
    • MySQL为源的迁移
      • 腾讯云MySQL迁移至RDS MySQL
      • RDS MySQL迁移至GaiaDB
      • 自建MySQL迁移至GaiaDB
      • 自建MySQL迁移至RDS MySQL
      • 阿里云PolarDB迁移至GaiaDB
      • RDS MySQL实例间的迁移
      • 阿里云MySQL迁移至RDS MySQL
      • MySQL迁移至Kafka
    • 异构数据库间的数据类型映射关系
      • 百度智能云DTS数据类型
      • DTS支持的数据源端
        • 将Kafka作为源端
        • 将Redis标准版作为源端
        • 将GaiaDB作为源端
        • 将Oracle作为源端
        • 将SQL Server作为源端
        • 将云上百度DRDS作为源端
        • 将MongoDB分片集作为源端
        • 将PostgreSQL作为源端
        • 将MongoDB副本集作为源端
        • 将MySQL作为源端
      • DTS支持的数据目的端
        • 将SQL Server作为目标端
        • 将Elasticsearch作为DTS目的端
        • 将GaiaDB作为目标端
        • 将Palo作为目标端
        • 将DataHub作为目标端
        • 将PostgreSQL作为目标端
        • 将MySQL作为目标端
        • 将Kafka作为DTS目标端
    • SQL Server 为源的迁移
      • 自建SQL Server迁移至RDS SQL Server
    • MongoDB为源的迁移
      • 自建MongoDB分片集迁移至DocDB MongoDB
      • DocDB MongoDB副本集迁移至DocDB MongoDB
    • Kafka为源的迁移
      • 自建Kafka迁移至消息服务 for Kafka
    • PostgreSQL为源的迁移
      • RDS PostgreSQL实例间的迁移
      • 自建PostgreSQL迁移至RDS PostgreSQL
      • AWS PostgreSQL迁移至RDS PostgreSQL
    • Redis为源的迁移
      • 使用DTS实现自建Redis标准版到百度智能云SCS for Redis标准版的数据迁移
      • 云数据库Redis实例间的迁移
      • 自建Redis迁移至云数据库Redis(含PegaDB)
    • Milvus为源的迁移
      • 自建 Milvus 迁移至向量数据库 VectorDB
  • 产品动态
    • 功能发布记录
    • 公告
      • 数据传输服务DTS支持多规格数据传输任务
      • 数据传输服务DTS任务状态升级通知
  • 预检查项
    • TiDB检查项
    • PostgreSQL检查项
    • MySQL检查项
    • Palo检查项
    • Oracle检查项
    • GaiaDB-X检查项
    • RocketMQ检查项
    • MongoDB检查项
    • Redis检查项
    • Elasticsearch检查项
    • GaiaDB检查项
    • Kafka检查项
    • 预检查不通过处理方法
      • 源库、目标库的连接数是否满足要求检查
      • 迁移表依赖的外键父表是否迁移检查
      • 目的数据库是否只读检查
      • 目的数据库的账号权限是否满足迁移要求检查
      • 目的库中表是否为空检查
      • 源库和目标库中SQL_MODE是否合法检查
      • 数据传输服务器是否能连通目的数据库检查
      • 源数据库的版本号检查
      • 源数据库的账号权限是否满足迁移要求检查
      • 迁移表是否有不支持的存储引擎检查
      • 预检查项汇总
      • 迁移表的表结构在目的库是否存在检查
      • 目的数据库待迁入的数据库是否可用检查
      • 目的库是否存在跟待迁移对象同名的结构对象检查
      • 数据传输服务器是否能连通源数据库检查
  • 服务支持
    • 相关协议
      • DTS服务等级协议SLA
    • 常见问题
      • 使用类问题
      • 数据迁移问题
      • 常见问题总览
      • 数据同步问题
  • 文档中心
  • arrow
  • 数据传输服务DTS
  • arrow
  • API3.0
  • arrow
  • 数据传输任务
  • arrow
  • demo
  • arrow
  • 专线迁移MongoDB分片集迁移到云数据库MongoDB分片集
本页目录
  • 接口说明
  • 请求结构
  • 请求体参数
  • OrderInfo字段数据结构说明
  • Src字段数据结构说明
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • DtsTask字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • PreCheckResultItem字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例
  • 接口说明
  • 请求结构
  • 请求体参数
  • 响应头参数
  • 响应体参数
  • 响应体字段数据结构说明
  • 请求示例
  • 响应示例

专线迁移MongoDB分片集迁移到云数据库MongoDB分片集

更新时间:2025-08-21

创建任务

接口说明

创建任务。

请求结构

JSON
1POST /v1/task
2Host: dts.baidubce.com    
3Authorization: authorization string
4{
5  "crossRegionTag": 0,
6  "directionType": "single",
7  "standard": "large",
8  "productType": "postpay",
9  "sourceInstanceType": "public",
10  "targetInstanceType": "bcerds",
11  "type": "migration",
12  "orderInfo": {
13    "src": {
14        "instanceType": "bcegateway",
15        "dbType": "mongodbCluster",
16        "sliceNum": 2,
17        "region": "bd",
18        "vpcShortId": "vpc-2a0giawvdben",
19        "subnetShortId": "sbn-iqxzq6nezp6k",
20        "zone": "cn-bd-b"
21      },
22      "dst": {
23        "instanceType": "bcedocdb",
24        "dbType": "mongodbCluster",
25        "region": "bd"
26     }
27  }
28}

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
type String 是 任务类型(数据传输任务:migration),目前仅支持数据传输任务 migration Request Body 参数
productType String 是 付费类型(后付费:postpay),目前仅支持后付费 postpay Request Body 参数
standard String 是 实例规格(small;medium;large;xlarge) large Request Body 参数
sourceInstanceType String 是 源端类型(百度智能云数据库:bcerds;自建数据存储:public) bcerds Request Body 参数
targetInstanceType String 是 目标端类型(百度智能云数据库:bcerds;自建数据存储:public) bcerds RequestBody 参数
crossRegionTag Integer 是 跨地域标识(当源端、目标端类型均为百度智能云数据库且跨地域时:1;其他情况:0) 0 Request Body 参数
directionType String 是 同步方向(单向同步:single;双向同步:bidirect),目前仅支持单向同步 single Request Body 参数
orderInfo OrderInfo 是 购买类型 orderInfo Request Body 参数
rollback String 否 一键反向,1为创建一键反向任务,其余时候不传该参数 1 Request Body 参数

OrderInfo字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
src Src 是 源端 src
dst Src 是 目标端 src

Src字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
instanceType String 是 源端接入类型(云数据库RDS:bcerds;云数据库 DocDB for MongoDB:bcedocdb;云数据库 Redis:bcescs;云数据库专属集群DDC:bceddc;云原生数据库 GaiaDB-S:bcegaiadb;公网:public;专线接入:bceet;云服务器BCC:bcebcc;物理服务器BBC:bcebbc;专属服务器DCC:bcedcc;专线迁移:bcegateway(src或dst只支持一端类型为bcegateway)) public
dbType String 是 源端数据类型(mysql;pg;SQL Server:mssql;oracle;MongoDB副本集:mongodb;MongoDB分片集:mongodbCluster;社区集群版:openRedisCluster;企业集群版:redisCluster;标准版:redis;kafka;elasticsearch;palo) mysql
sliceNum String 否 分片数量 1
region String 否 地域 bj
zone String 否 接入类型为bcegateway时,需要指定可用区 cn-bj-a
vpcShortId String 否 接入类型为bcegateway时,需要指定VPC短ID vpc-46k27rb9wppz
subnetShortId String 否 接入类型为bcegateway时,需要指定子网短ID sbn-qtm3d4eituqc

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
dtsTasks List<DtsTask> 是 任务ID列表 dtsmxxyy1234

DtsTask字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
dtsId String 是 任务ID dtsmxxyy1234

请求示例

JSON
1POST /v1/task
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 
5{
6  "crossRegionTag": 0,
7  "directionType": "single",
8  "standard": "large",
9  "productType": "postpay",
10  "sourceInstanceType": "public",
11  "targetInstanceType": "bcerds",
12  "type": "migration",
13   "orderInfo": {
14     "src": {
15         "instanceType":"bcegateway",
16         "dbType":"mongodbCluster",
17         "sliceNum":2,
18         "region": "bd",
19         "vpcShortId":"vpc-2a0giawvdben",
20         "subnetShortId":"sbn-iqxzq6nezp6k",
21         "zone":"cn-bd-b"
22        },
23        "dst": {
24          "instanceType": "bcedocdb",
25          "dbType": "mongodbCluster",
26          "region": "bd"
27        }
28    }
29}

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4    "dtsTasks": [
5        {
6          "dtsId": "dtsgsi2nut0kq7s8fvtq"
7        }
8    ]
9}

配置任务

接口说明

配置任务。

请求结构

JSON
1POST /v1/task/{dtsId}/config
2Host: dts.baidubce.com    
3Authorization: authorization string  
4{
5    "type": "migration",
6    "taskName": "专线迁移的MongoDB分片集-云数据库MongoDB分片集",
7    "dataType": [
8        "base",
9        "increment"
10    ],
11    "srcConnection": {
12        "instanceType": "bcegateway",
13        "dbType": "mongodbCluster",
14        "region": "bd",
15        "dbServer": "172.16.16.50:27000",
16        "shardUrl": "172.16.16.50:37017;172.16.16.50:47017",
17        "dbUser": "root",
18        "dbPass": "root123#", 
19        "vpcShortId": "vpc-2a0giawvdben",
20        "subnetShortId": "sbn-iqxzq6nezp6k",
21        "zone": "cn-bd-b"
22    },
23    "dstConnection": {
24        "instanceType": "bcedocdb",
25        "dbType": "mongodbCluster",
26        "region": "bd",
27        "instanceId": "m-jpkwMe",
28        "dbServer": "",
29        "dbUser": "root",
30        "dbPass": "root123#"
31    },
32    "schemaMapping": [],
33    "granularity": "instance"
34}

请求体参数

参数名称 参数类型 是否必选 描述 示例值 参数位置
dtsId String 是 任务ID dtsmxxxyyy URL参数
type String 是 任务类型(数据传输任务:migration),目前仅支持数据传输任务 migration Request Body 参数
dataType String[] 是 传输数据类型数组(schema:结构迁移;base:全量迁移;increment:增量迁移) ["base"] Request Body 参数
srcConnection Connection 是 源端 srcConnection Request Body 参数
dstConnection Connection 是 目标端 dstConnection Request Body 参数
granularity String 是 传输任务的粒度(instance:实例级;dbtb:库表级) instance Request Body 参数
schemaMapping SchemaMapping 是 schemaMapping schemaMapping Request Body 参数
accountMapping AccountMapping[] 否 账号迁移 accountMapping Request Body 参数
incrIgnoreType String 否 特殊DDL过滤 drop,truncate Request Body 参数
initPosition InitPosition 否 自定义同步点 initPosition Request Body 参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必选 描述 示例值
dtsId String 是 任务ID dtsxxxyyyzzz

请求示例

JSON
1POST /v1/task/{dtsId}/config
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 
5{{
6    "type": "migration",
7    "taskName": "专线迁移的MongoDB分片集-云数据库MongoDB分片集",
8    "dataType": [
9        "base",
10        "increment"
11    ],
12    "srcConnection": {
13        "instanceType": "bcegateway",
14        "dbType": "mongodbCluster",
15        "region": "bd",
16        "dbServer": "172.16.16.50:27000",
17        "shardUrl": "172.16.16.50:37017;172.16.16.50:47017",
18        "dbUser": "root",
19        "dbPass": "root123#", 
20        "vpcShortId": "vpc-2a0giawvdben",
21        "subnetShortId": "sbn-iqxzq6nezp6k",
22        "zone": "cn-bd-b"
23    },
24    "dstConnection": {
25        "instanceType": "bcedocdb",
26        "dbType": "mongodbCluster",
27        "region": "bd",
28        "instanceId": "m-jpkwMe",
29        "dbServer": "",
30        "dbUser": "root",
31        "dbPass": "root123#"
32        
33    },
34    "schemaMapping": [],
35    "granularity": "instance"
36}

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "dtsId" : "dtsxxxyyyzzz"
5}

前置检查

接口说明

当配置完任务,开始前置检查。

请求结构

JSON
1POST /v1/task/{dtsId}/precheck
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result Object 否 暂未使用 null

请求示例

JSON
1POST /v1/task/{dtsId}/precheck
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "result" : { },
5  "success" : true
6}

查询前置检查结果

接口说明

任务启动前的前置检查,包括连通性,对象存在性,binlog格式等。

请求结构

JSON
1GET /v1/task/{dtsId}/precheck
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result PreCheckResultItem[] 是 前置检查结果集合

PreCheckResultItem字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
name String 是 名称 srcOracleConnect
subscription String 是 描述 检查数据传输服务器是否能连通源数据库
message String 是 提示语
status String 是 状态 pass

请求示例

JSON
1GET /v1/task/{dtsId}/precheck
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "result" : [{
5    "name" : "srcOracleConnect",
6    "subscription" : "检查数据传输服务器是否能连通源数据库",
7    "message" : "message",
8    "status" : "pass"
9  }, {
10    "name" : "srcOracleConnect",
11    "subscription" : "检查数据传输服务器是否能连通源数据库",
12    "message" : "message",
13    "status" : "pass"
14  }],
15  "success" : true
16}

强制跳过前置检查

接口说明

强制跳过前置检查。

请求结构

JSON
1PUT /v1/task/{dtsId}?skipPrecheck
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result Object 否 暂未使用 null

请求示例

JSON
1PUT /v1/task/{dtsId}?skipPrecheck
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "result" : { },
5  "success" : true
6}

启动任务

接口说明

当配置完任务,前置检查通过后,可以启动任务。

请求结构

JSON
1POST /v1/task/{dtsId}/start
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result Object 否 暂未使用 null

请求示例

JSON
1POST /v1/task/{dtsId}/start
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "result" : { },
5  "success" : true
6}

暂停任务

接口说明

运行中的任务可以暂停。

请求结构

JSON
1POST /v1/task/{dtsId}/pause
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result Object 否 暂未使用 null

请求示例

JSON
1POST /v1/task/{dtsId}/pause
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "result" : { },
5  "success" : true
6}

结束任务

接口说明

结束任务。

请求结构

JSON
1POST /v1/task/{dtsId}/shutdown
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result Object 否 暂未使用 null

请求示例

JSON
1POST /v1/task/{dtsId}/shutdown
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2
3{
4  "result" : { },
5  "success" : true
6}

释放任务

接口说明

释放并删除任务。

请求结构

JSON
1DELETE /v1/task/{dtsId}
2Host: dts.baidubce.com    
3Authorization: authorization string  

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsxxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
success Boolean 是 是否成功 true
result Object 否 暂未使用 null

请求示例

JSON
1DELETE /v1/task/{dtsId}
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2{
3  "result":{},
4  "success" : true
5}

查询任务信息

接口说明

查看指定ID的数据传输任务信息。

请求结构

JSON
1GET /v1/task/{dtsId}
2Host: dts.baidubce.com    
3Authorization: authorization string

请求体参数

参数名称 参数类型 是否必须 描述 示例值 参数位置
dtsId String 是 任务ID dtsmxxxyyy URL参数

响应头参数

除公共头域,无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称 参数类型 是否必须 描述 示例值
dtsId String 是 任务ID dtsmxxyy1234
taskName String 是 任务名称 dtsmxxyy1234
status String 是 任务状态:
unConfig:未配置,当用户创建完任务后,就进入未配置状态, 该状态只有dtsId信息;
ready:未启动,当配置完后任务后就进入未启动状态,这时就包含任务的所有信息;
checking:前置检查中,当用户点击启动后,先会进行前置检查;
checkPass:前置检查通过,只有前置检查通过后,才可以进行启动任务;
checkFailed:前置检查失败,任务启动时,会进行前置检查,若检查失败,就进入该状态,这时可以进行修改任务或直接结束任务;
running:运行中,前置检测通过后,就进入该状态,包括数据迁移中或数据同步中;
stopping:暂停中,处于该状态的任务不能进行任何操作;
stopped:已暂停,从该状态启动,会进行断点续传,比如:暂停后修改数据同步对象;
stopCheckFailed:已暂停(新增同步对象前置检查失败),当新增同步对象时,会进行前置检查,如果检查失败,回到已暂停状态,但是可以查看检查失败原因;
runFailed:运行失败,当运行过程中出现异常就进入该状态,如果是可恢复错误,修复后可继续启动,如果是不可恢复错误,只能结束任务;
finished:任务结束,包括手工进行结束,或任务完成后自动结束,或出现不可恢复的错误
finished
dataType DataType 是
region String 是 地域 bj
createTime String 是 创建时间 2020-12-10T13: 24: 10Z
srcConnection Connection 是 源端 srcConnection
dstConnection Connection 是 目标端 dstConnection
schemaMapping SchemaMapping 是 schemaMapping schemaMapping
runningTime Integer 是 任务已运行时长 20
subStatus List<SubStatus> 是 子任务状态
dynamicInfo DynamicInfo 是 dynamicInfo dynamicInfo
errmsg String 是 执行失败时返回的错误信息,执行成功时为空字符串
sdkRealtimeProgress String 是 (只限数据订阅)任务实时进度,UTC格式 sdkRealtimeProgress
granularity String 是 传输任务的粒度,目前只区分实例级和库表级两种 dbtb
subDataScope SubDataScope 是 (只限数据订阅)订阅通道数据范围 subDataScope
payInfo PayInfo 是 付费信息 payInfo
lockStatus String 是 任务是否被锁定,取值有:unlock,lockExpiration unlock
initPosition InitPosition 是 自定义同步点 initPosition
accountMapping AccountMapping[] 是 账号迁移 accountMapping
incrIgnoreType String 是 特殊DDL过滤 drop,truncate
statistic Statistic 是 DTS任务性能统计数据。包含:readSpeed(读取速率,行/s)、writeSpeed(写入速率,行/s) writeSpeed
checksumResult ChecksumResult 是 校验结果,可能值:CONSISTENT(一致),INCONSISTENT(不一致),NONE(未知,校验任务运行未结束) CONSISTENT
dtsIdPos String 是 双向同步任务时,正向任务ID dtsmxxyy1234
dtsIdNeg String 是 双向同步任务时,反向任务ID dtsmxxyy1234
dtsTaskPos DtsTaskPos 是 双向同步任务时,正向任务信息 dtsTaskPos
dtsTaskNeg DtsTaskNeg 是 双向同步任务时,反向任务信息 dtsTaskNeg
dtsTasks DtsTasks[] 是 任务组任务时,子任务信息 dtsTasks

请求示例

JSON
1GET /v1/task/{dtsId}
2Host: dts.baidubce.com    
3Content-Type: application/json     
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943 

响应示例

JSON
1HTTP/1.1 200 OK
2{
3    "taskName": "dtsgtc6cjmk7zp76ulwf",
4    "status": "running",
5    "dataType": [
6       "schema",
7       "base",
8       "increment"
9    ],
10    "region": "bd",
11    "createTime": "2022-12-02T04:04:32Z",
12    "srcConnection": {
13       "instanceType": "bcegateway",
14       "dbType": "mongodbCluster",
15       "region": "bd",
16       "dbServer": "172.16.16.50:27000",
17       "shardUrl": "172.16.16.50:37017;172.16.16.50:47017",
18       "dbUser": "root",
19       "dbPass": "root123#",
20       "vpcShortId": "vpc-2a0giawvdben",
21       "subnetShortId": "sbn-iqxzq6nezp6k",
22       "zone": "cn-bd-b"
23    },
24    "dstConnection": {
25       "instanceType": "bcedocdb",
26       "dbType": "mongodbCluster",
27       "region": "bd",
28       "instanceId": "m-jpkwMe",
29       "dbServer": "",
30       "dbUser": "root",
31       "dbPass": "root123#"
32        
33    },
34    "schemaMapping": [],
35    "payInfo": {
36       "productType": "postpay",
37       "sourceInstanceType": "OffBce",
38       "targetInstanceType": "OnBce",
39       "crossRegionTag": 1,
40       "createTime": 1669953872000,
41       "standard": "Large",
42       "endTime": null
43    },
44    "incrNetType": "large",
45    "dtsTasks": [
46        {
47            "dtsId": "dtsmkzo5pf8j1cq6esl7",
48            "taskName": "son of dtsgtc6cjmk7zp76ulwf",
49            "status": "running",
50            "srcConnection": {
51              "instanceType": "bcegateway",
52              "dbType": "mongos",
53              "region": "bd",
54              "dbServer": "172.16.16.50:27000",
55              "shardUrl": "172.16.16.50:37017",
56              "dbUser": "root",
57              "dbPass": "",
58              "vpcShortId": "vpc-2a0giawvdben",
59              "subnetShortId": "sbn-iqxzq6nezp6k",
60              "zone": "cn-bd-b",
61              "shardName": "shard1"
62            },
63            "dstConnection": {
64                "instanceType": "bcedocdb",
65                "region": "bd",
66                "dbType": "mongos",
67                "instanceId": "m-r8cSZM",
68                "dbHost": "",
69                "dbPort": "",
70                "dbUser": "root",
71                "dbPass": "",
72                "authDB": "admin"
73            },
74            "dynamicInfo": {
75                "schema": [
76                    {
77                      "current": "-1",
78                      "count": "-1",
79                      "speed": "-1",
80                      "expectFinishTime": "-1"
81                    }
82                ],
83                "base": [
84                    {
85                      "count": "321597",
86                      "current": "321597",
87                      "finishTableCount": "1",
88                      "totalTableCount": "1",
89                      "expectFinishTime": -1,
90                      "speed": -1
91                    }
92                ],
93                "increment": {
94                    "delay": 0,
95                    "position": "1669954235,1"
96                }
97            },
98            "message": "{}",
99            "schemaMapping": [],
100            "granularity": "instance",
101            "createTime": "2022-12-02T04:07:06Z",
102            "dataType": [
103                "schema",
104                "base",
105                "increment"
106            ],
107            "subStatus": [
108                {
109                  "s": "closed",
110                  "b": "closed",
111                  "i": "running"
112                }
113            ]
114        },
115        {
116            "dtsId": "dtsmyr9avf3qeeb2p1mr",
117            "taskName": "son of dtsgtc6cjmk7zp76ulwf",
118            "status": "running",
119            "srcConnection": {
120                "instanceType": "bcegateway",
121                "dbType": "mongos",
122                "region": "bd",
123                "dbServer": "172.16.16.50:27000",
124                "shardUrl": "172.16.16.50:47017",
125                "dbUser": "root",
126                "dbPass": "",
127                "vpcShortId": "vpc-2a0giawvdben",
128                "subnetShortId": "sbn-iqxzq6nezp6k",
129                "zone": "cn-bd-b",
130                "shardName": "shard2"
131            },
132            "dstConnection": {
133                "instanceType": "bcedocdb",
134                "region": "bd",
135                "dbType": "mongos",
136                "instanceId": "m-r8cSZM",
137                "dbHost": "",
138                "dbPort": "",
139                "dbUser": "root",
140                "dbPass": "",
141                "authDB": "admin"
142            },
143            "dynamicInfo": {
144                "schema": null,
145                "base": [
146                    {
147                      "count": "321597",
148                      "current": "321597",
149                      "finishTableCount": "1",
150                      "totalTableCount": "1",
151                      "expectFinishTime": -1,
152                      "speed": -1
153                    }
154                ],
155                "increment": {
156                   "delay": 0,
157                   "position": "1669954238,1"
158                }
159            },
160            "message": "{}",
161            "schemaMapping": [],
162            "granularity": "instance"
163            "createTime": "2022-12-02T04:07:06Z",
164            "dataType": [
165              "base",
166              "increment"
167            ],
168            "subStatus": [
169                {
170                 "s": null,
171                 "b": "closed",
172                 "i": "running"
173                }
174            ]
175        }
176    ]
177}

上一篇
专线迁移MySQL迁移到云数据库RDS-数据校验
下一篇
专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-数据校验