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":"redis","region":"bd","vpcShortId":"vpc-8mhenwrw1k6s","subnetShortId":"sbn-xyndrgbzemup","zone":"cn-bd-a"},"dst":{"instanceType":"bcescs","dbType":"redis","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))
POST /v1/task
Host: dts.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943{"crossRegionTag":0,"directionType":"single","standard":"large","productType":"postpay","sourceInstanceType":"public","targetInstanceType":"bcerds","type":"migration","orderInfo":{"src":{"instanceType":"bcegateway",//源端接入类型bcegateway专线迁移"dbType":"redis",//源端数据类型"region":"bd",//源端地域"vpcShortId":"vpc-8mhenwrw1k6s",// 接入类型为bcegateway时,需要指定VPC短ID"subnetShortId":"sbn-xyndrgbzemup",//接入类型为bcegateway时,需要指定子网短ID"zone":"cn-bd-a"//接入类型为bcegateway时,需要指定可用区},"dst":{"instanceType":"bcescs",//目标端接入类型bcescs云数据库 DocDB for Redis"dbType":"redis",//目标端数据类型"region":"bd"//目标端地域}}}
响应示例
HTTP/1.1200 OK
{"dtsTasks":[{"dtsId":"dtsm0eoplf9kemw0z1yi"}]}
配置任务
接口说明
配置任务。
请求结构
POST /v1/task/{dtsId}/config
Host: dts.baidubce.com
Authorization: authorization string
{"type":"migration","taskName":"专线迁移的Redis标准版迁移到云数据库SCS for Redis标准版","dataType":["increment","base"],"srcConnection":{"instanceType":"bcegateway","dbType":"redis","region":"bd","dbHost":"10.136.158.21","dbPort":"3333","dbPass":"","vpcShortId":"vpc-2a0giawvdben","subnetShortId":"sbn-ka9xp8yuj81n","zone":"cn-bd-c","positionStrategy":"fail"},"dstConnection":{"instanceType":"bcescs","dbType":"redis","region":"bd","instanceId":"scs-bdbl-jcoovhwewnwi","dbPass":""},"schemaMapping":[],"granularity":"instance"}
请求体参数
请求参数
参数名称
参数类型
是否必选
描述
示例值
参数位置
dtsId
String
是
任务ID
"dtsmxxxyyy"
URL参数
type
String
是
任务类型(数据传输任务:migration),目前仅支持数据传输任务
migration
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: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943{"type":"migration","taskName":"专线迁移的Redis标准版迁移到云数据库SCS for Redis标准版","dataType":[//传输数据类型数组(base:全量迁移;increment:增量迁移)"increment","base"],"srcConnection":{"instanceType":"bcegateway","dbType":"redis","region":"bd","dbHost":"10.136.158.21","dbPort":"3333","dbPass":"","vpcShortId":"vpc-2a0giawvdben","subnetShortId":"sbn-ka9xp8yuj81n","zone":"cn-bd-c","positionStrategy":"fail"//同步点失效的处理策略:fail(同步点失效时直接报任务失败);base(同步点失效时自动重新开始全量和增量迁移)},"dstConnection":{"instanceType":"bcescs","dbType":"redis","region":"bd","instanceId":"scs-bdbl-jcoovhwewnwi","dbPass":""},"schemaMapping":[],"granularity":"instance"//传输任务的粒度(instance:实例级)}
响应示例
HTTP/1.1200 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
Host: dts.baidubce.com
Content-Type:appplication/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
响应示例
HTTP/1.1200 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
Host: dts.baidubce.com
Content-Type:appplication/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
响应示例
HTTP/1.1200 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
Content-Type:appplication/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
请求体参数
请求参数
参数名称
参数类型
是否必须
描述
示例值
参数位置
dtsId
String
是
任务ID
"dtsxxxxyyy"
URL参数
响应头参数
除公共头域,无其它特殊头域。
响应体参数
响应体字段数据结构说明
参数名称
参数类型
是否必须
描述
示例值
success
Boolean
是
是否成功
true
result
Object
否
暂未使用
null
请求示例
PUT /v1/task/{dtsId}?skipPrecheck
Host: dts.baidubce.com
Content-Type:appplication/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
响应示例
HTTP/1.1200 OK
{"result":{},"success":true}
启动任务
接口说明
当配置完任务,前置检查通过后,可以启动任务。
请求结构
POST /v1/task/{dtsId}/start
Host: dts.baidubce.com
Content-Type:appplication/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
请求体参数
请求参数
参数名称
参数类型
是否必须
描述
示例值
dtsId
String
是
任务ID
"dtsxxxxyyy"
响应头参数
除公共头域,无其它特殊头域。
响应体参数
响应体字段数据结构说明
参数名称
参数类型
是否必须
描述
示例值
success
Boolean
是
是否成功
true
result
Object
否
暂未使用
null
请求示例
POST /v1/task/{dtsId}/start
Host: dts.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
响应示例
HTTP/1.1200 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
Host: dts.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
响应示例
HTTP/1.1200 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
Host: dts.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
GET /v1/task/{dtsId}
Host: dts.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
响应示例
HTTP/1.1200 OK
{"dtsId":"dtsm0eoplf9kemw0z1yi","taskName":"专线迁移的Redis标准版迁移到云数据库SCS for Redis标准版","status":"running","dataType":["base","increment"],"region":"bj","createTime":"2022-09-13T07:03:19Z","srcConnection":{"instanceType":"bcegateway","region":"bj","dbType":"redis","dbHost":"172.16.1.73","dbPort":3306,"dbUser":"","dbPass":"","instanceId":"","vpcId":"9556bf45-5867-4495-83c5-bd945b782503","vpcName":"zhaixinrui","vpcCidr":"172.16.0.0/16","vpcShortId":"vpc-it3v6qt3jhvj","subnetShortId":"sbn-ka9xp8yuj81n","zone":"cn-bd-c","backendIp":"172.16.1.73","backendPort":3306,"vpcEndpointId":"03227b7a-0441-4937-b82a-f1d0a773b498","positionStrategy":"fail"},"dstConnection":{"instanceType":"bcescs","region":"bj","dbType":"redis","dbHost":"10.7.80.198","dbPort":3306,"dbUser":"","dbPass":"","instanceId":""},"schemaMapping":[],"granularity":"instance","subStatus":[{"b":"closed",//全量"i":"running"//增量}],"dynamicInfo":{"increment":{"delay":"1",//延迟信息, 单位为秒。延迟为0时表示增量同步追平"position":"12345"//增量同步位点。增量同步点与源端一致时表示增量同步追平},"base":{"current":"60000",// 已迁移数据行数"count":"150000",// 迁移总数据行数"speed":"1500",// 迁移速度"expectFinishTime":"87000"// 预测剩余时间(s)}},"statistic":{"readSpeed":"0.00",//读取速率, 行/s"writeSpeed":"0.00"//写入速率, 行/s},"subDataScope":{"startTime":"","endTime":""},"payInfo":{"productType":"postpay","sourceInstanceType":"OffBce","targetInstanceType":"OnBce","crossRegionTag":1,"createTime":1663052601000,"standard":"Large","endTime":null},"incrNetType":"large","netType":"large"}
查询任务列表
接口说明
查看所有数据传输任务列表
请求结构
POST /v1/task/list
Host: dts.baidubce.com
Authorization: authorization string
{"maxKeys":15,"marker":"dtsmxxxyyyzzz","type":"migration"}
请求参数
参数名称
参数类型
是否必须
描述
示例值
参数位置
type
String
是
任务类型
migration
Request Body 参数
marker
String
否
分页参数,初次请求无需设置,后续请求使用上次响应中的nextMarker
dtsmxxxyyyzzz
Request Body 参数
maxKeys
Integer
否
分页参数,每页数据条数,默认为10
15
Request Body 参数
响应头参数
除公共头域,无其它特殊头域。
响应体参数
响应体字段数据结构说明
参数名称
参数类型
是否必须
描述
示例值
task
List<Task>
是
任务数组
task
nextMarker
String
是
分页参数,下一页标记
dtsmxxxyyy
maxKeys
Integer
是
分页参数,数据条数最大值
10
truncated
Boolean
是
是否截断
false
请求示例
POST /v1/task/list
Host: dts.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943{"maxKeys":15,"marker":"dtsmxxxyyyzzz","type":"migration"}
响应示例
HTTP/1.1200 OK
{"nextMarker":"dtsmmcgm8tfn91kjdx6l","marker":null,"maxKeys":10,"isTruncated":true,"task":[{"dtsId":"dtsmmcgm8tfn91kjdx6l","taskName":"dtsmmcgm8tfn91kjdx6l","status":"running","dataType":["base","increment"],"region":"bd","createTime":"2022-11-24T03:45:52Z","srcConnection":{"dbServer":"","instanceType":"bcegateway","region":"bd","dbType":"redis","dbHost":"100.80.143.80","dbPort":28,"dbUser":"","dbPass":"","instanceId":"","subnetShortId":"sbn-ka9xp8yuj81n","vpcId":"1cd2dd00-b2c8-4053-9550-594a2991cc6e","vpcShortId":"vpc-2a0giawvdben","zone":"cn-bd-c"},"dstConnection":{"dbServer":"","instanceType":"public","region":"bj","dbType":"redis","dbHost":"10.156.64.44","dbPort":7020,"dbUser":"","dbPass":"","instanceId":""},"schemaMapping":null,"granularity":null,"subStatus":[{"b":"running","i":"queue"}],"dynamicInfo":{"base":[],"increment":null},"statistic":null,"errmsg":null,"sdkRealtimeProgress":"""subDataScope":{"startTime":"","endTime":""}"lockStatus":"unlock","expireTime":"-1","checksumResult":"CONSISTENT"}]}