专线迁移MongoDB副本集迁移到云数据库MongoDB副本集

更新时间：2023-02-03

创建任务

接口说明

创建任务。

请求结构

POST /v1/task
Host: dts.baidubce.com    
Authorization: authorization string  
{
    "crossRegionTag": 0,
    "directionType": "single",
    "standard": "large",
    "productType": "postpay",
    "sourceInstanceType": "public",
    "targetInstanceType": "bcerds",
    "type": "migration",
    "orderInfo": {
        "src": {
            "instanceType": "bcegateway",
            "dbType": "mongodb",
            "region": "bd",
            "vpcShortId": "vpc-2a0giawvdben",
            "subnetShortId": "sbn-ka9xp8yuj81n",
            "zone": "cn-bd-c"
        },
        "dst": {
            "instanceType": "bcedocdb",
            "dbType": "mongodb",
            "region": "bd"
        }
    }
}

请求体参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
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	Request Body 参数
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；云数据库 SCS for 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

请求示例

POST /v1/task
Host: dts.baidubce.com    
ContentType: application/json     
Authorization: authorization string  


{
    "crossRegionTag": 0,
    "directionType": "single",
    "standard": "large",
    "productType": "postpay",
    "sourceInstanceType": "public",
    "targetInstanceType": "bcerds",
    "type": "migration",
    "orderInfo": {
        "src": {
            "instanceType": "bcegateway",
            "dbType": "mongodb",
            "region": "bd",
            "vpcShortId": "vpc-2a0giawvdben",
            "subnetShortId": "sbn-ka9xp8yuj81n",
            "zone": "cn-bd-c"
        },
        "dst": {
            "instanceType": "bcedocdb",
            "dbType": "mongodb",
            "region": "bd"
        }
    }
}

响应示例

HTTP/1.1 200 OK

{
    "dtsTasks": [
        {
            "dtsId": "dtsmhlbftwuczgoz47qs"
        }
    ]
}

配置任务

接口说明

配置任务。

请求结构

POST /v1/task/{dtsId}/config
Host: dts.baidubce.com    
Authorization: authorization string  
{
    "type": "migration",
    "taskName": "专线迁移的MongoDB副本集迁移到DocDB",
    "dataType": [
        "schema",
        "base",
        "increment"
    ],
    "srcConnection": {
        "instanceType": "bcegateway",
        "dbType": "mongodb",
        "region": "bd",
        "dbServer": "172.16.16.50:27000",
        "dbUser": "root",
        "dbPass": "root123#",
        "vpcShortId": "vpc-2a0giawvdben",
        "subnetShortId": "sbn-0xb61yks6pk5",
        "zone": "cn-bd-b",
    },
    "dstConnection": {
        "instanceType": "bcedocdb",
        "dbType": "mongodb",
        "region": "bd",
        "instanceId": "m-JToNgx",
        "dbServer": "",
        "dbUser": "root",
        "dbPass": "root123#"
    },
    "schemaMapping": [],
    "granularity": "instance"
}

请求体参数

参数名称	参数类型	是否必选	描述	示例值	参数位置
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

请求示例

POST /v1/task/{dtsId}/config
Host: dts.baidubce.com    
ContentType: application/json     
Authorization: authorization string  


{
    "type": "migration",
    "taskName": "专线迁移的MongoDB副本集迁移到DocDB",
    "dataType": [
        "schema",
        "base",
        "increment"
    ],
    "srcConnection": {
        "instanceType": "bcegateway",
        "dbType": "mongodb",
        "region": "bd",
        "dbServer": "172.16.16.50:27000",
        "dbUser": "root",
        "dbPass": "root123#",
        "vpcShortId": "vpc-2a0giawvdben",
        "subnetShortId": "sbn-0xb61yks6pk5",
        "zone": "cn-bd-b",
    },
    "dstConnection": {
        "instanceType": "bcedocdb",
        "dbType": "mongodb",
        "region": "bd",
        "instanceId": "m-JToNgx",
        "dbServer": "",
        "dbUser": "root",
        "dbPass": "root123#"
    },
    "schemaMapping": [],
    "granularity": "instance"
}

响应示例

HTTP/1.1 200 OK

{
  "dtsId" : "dtsxxxyyyzzz"
}

前置检查

接口说明

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

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

请求示例

POST /v1/task/{dtsId}/precheck

响应示例

HTTP/1.1 200 OK

{
  "result" : { },
  "success" : true
}

查询前置检查结果

接口说明

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

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

PreCheckResultItem字段数据结构说明

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

请求示例

GET /v1/task/{dtsId}/precheck

响应示例

HTTP/1.1 200 OK

{
  "result" : [ {
    "name" : "srcOracleConnect",
    "subscription" : "检查数据传输服务器是否能连通源数据库",
    "message" : "message",
    "status" : "pass"
  }, {
    "name" : "srcOracleConnect",
    "subscription" : "检查数据传输服务器是否能连通源数据库",
    "message" : "message",
    "status" : "pass"
  } ],
  "success" : true
}

强制跳过前置检查

接口说明

强制跳过前置检查。

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

请求示例

PUT /v1/task/{dtsId}?skipPrecheck

响应示例

HTTP/1.1 200 OK

{
  "result" : { },
  "success" : true
}

启动任务

接口说明

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

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

请求示例

POST /v1/task/{dtsId}/start

响应示例

HTTP/1.1 200 OK

{
  "result" : { },
  "success" : true
}

暂停任务

接口说明

运行中的任务可以暂停。

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

请求示例

POST /v1/task/{dtsId}/pause

响应示例

HTTP/1.1 200 OK

{
  "result" : { },
  "success" : true
}

结束任务

接口说明

结束任务。

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

请求示例

POST /v1/task/{dtsId}/shutdown

响应示例

HTTP/1.1 200 OK

{
  "result" : { },
  "success" : true
}

释放任务

接口说明

释放并删除任务。

请求结构

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

请求体参数

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

响应头参数

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

响应体参数

响应体字段数据结构说明

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

请求示例

DELETE /v1/task/{dtsId}

响应示例

HTTP/1.1 200 OK

{
  "result" : { },
  "success" : true
}

查询任务信息

接口说明

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

请求结构

GET /v1/task/{dtsId}
Host: dts.baidubce.com    
Authorization: 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

请求示例

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

响应示例

HTTP/1.1 200 OK
{
    "dtsId": "dtsmhlbftwuczgoz47qs",
    "taskName": "dtsmhlbftwuczgoz47qs",
    "status": "running",
    "dataType": [
        "schema",
        "base",
        "increment"
    ],
    "region": "bd",
    "createTime": "2022-11-30T02:46:43Z",
    "srcConnection": {
        "instanceType": "bcegateway",
        "dbType": "mongodb",
        "region": "bd",
        "dbServer": "172.16.16.50:27000",
        
"dbUser": "root",
        "dbPass": "",
        "vpcShortId": "vpc-2a0giawvdben"
        "subnetShortId": "sbn-0xb61yks6pk5",
        "zone": "cn-bd-b",
        "vpcId": "1cd2dd00-b2c8-4053-9550-594a2991cc6e",
        "vpcName": "默认私有网络",
        "vpcCidr": "172.16.0.0/16"
    },
    "dstConnection": {
        "instanceType": "bcedocdb",
        "dbType": "mongodb",
        "region": "bd",
        "instanceId": "m-JToNgx",
        "dbServer": "",
        
"dbUser": "root",
        "dbPass": ""
    },
    "schemaMapping": [],
    "granularity": "instance",
    "subStatus": [
        {
            "s": "closed",
            "b": "closed",
            "i": "running"
        }
    ],
    "dynamicInfo": {
        "schema": [//mongodb schema没有进度，显示-1
            {
                "current": "-1",
                "count": "-1",
                "speed": "-1",
                "expectFinishTime": "-1"
            }
        ],
        "base": [
            {
                
"count": "321597",
                "current": "321597",
                "finishTableCount": "1",
                "totalTableCount": "1",
                "expectFinishTime": -1,
                "speed": -1
            }
        ],
        "increment": {
            "delay": 0,
            "position": "1669896385,1"
        }
    },
    "statistic": {
        "readSpeed": "0.00",
        "writeSpeed": "0.00"
    },
    "errmsg": ""
    "subDataScope": {
        "startTime": "",
        "endTime": ""
    },
    "payInfo": {
        "productType": "postpay",
        "sourceInstanceType": "OffBce",
        "targetInstanceType": "OffBce",
        "crossRegionTag": 1,
        "createTime": 1669776406000,
        "standard": "Large",
        "endTime": null
    },
    
    "incrNetType": "large",
    "netType": "large", 
    "remark": ""
}

专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-数据校验

专线迁移的MongoDB分片集迁移到云数据库MongoDB分片集-数据校验

数据传输服务 DTS

专线迁移MongoDB副本集迁移到云数据库MongoDB副本集

创建任务

接口说明

请求结构

请求体参数

OrderInfo字段数据结构说明

Src字段数据结构说明

响应头参数

响应体参数

响应体字段数据结构说明

DtsTask字段数据结构说明

请求示例

响应示例

配置任务

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

请求示例

响应示例

前置检查

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

请求示例

响应示例

查询前置检查结果

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

PreCheckResultItem字段数据结构说明

请求示例

响应示例

强制跳过前置检查

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

请求示例

响应示例

启动任务

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

请求示例

响应示例

暂停任务

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

请求示例

响应示例

结束任务

接口说明

请求结构

请求体参数

响应头参数

响应体参数

响应体字段数据结构说明

请求示例

响应示例

释放任务

接口说明