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":"mysql","region":"bd","vpcShortId":"vpc-2a0giawvdben","subnetShortId":"sbn-ka9xp8yuj81n","zone":"cn-bd-c"},"dst":{"instanceType":"bcerds","dbType":"mysql","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/{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.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
响应示例
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
Authorization: authorization string
请求体参数
参数名称
参数类型
是否必须
描述
示例值
参数位置
dtsId
String
是
任务ID
dtsxxxxyyy
URL参数
响应头参数
除公共头域,无其它特殊头域。
响应体参数
响应体字段数据结构说明
参数名称
参数类型
是否必须
描述
示例值
success
Boolean
是
是否成功
true
result
Object
否
暂未使用
null
请求示例
PUT /v1/task/{dtsId}?skipPrecheck
响应示例
HTTP/1.1200 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.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
响应示例
HTTP/1.1200 OK
{"result":{},"success":true}
结束任务
接口说明
结束任务。
请求结构
POST /v1/task/{dtsId}/shutdown
Host: dts.baidubce.com
Authorization: authorization string