专线迁移MySQL迁移到云数据库RDS-一键反向
更新时间：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 "rollback": 1,
13 "orderInfo": {
14 "src": {
15 "instanceType": "bcegateway",
16 "dbType": "mysql",
17 "region": "bd",
18 "vpcShortId": "vpc-2a0giawvdben",
19 "subnetShortId": "sbn-ka9xp8yuj81n",
20 "zone": "cn-bd-c"
21 },
22 "dst": {
23 "instanceType": "bcerds",
24 "dbType": "mysql",
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 | 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 |
请求示例
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 "rollback": 1,
14 "orderInfo": {
15 "src": {
16 "instanceType": "bcegateway",
17 "dbType": "mysql",
18 "region": "bd",
19 "vpcShortId": "vpc-2a0giawvdben",
20 "subnetShortId": "sbn-ka9xp8yuj81n",
21 "zone": "cn-bd-c"
22 },
23 "dst": {
24 "instanceType": "bcerds",
25 "dbType": "mysql",
26 "region": "bd"
27 }
28 }
29}响应示例
JSON
1HTTP/1.1 200 OK
2
3{
4 "dtsTasks": [
5 {
6 "dtsId": "dtsr5g818m9dclz0gvf6"
7 }
8 ]
9}配置任务
接口说明
配置任务。
请求结构
JSON
1POST /v1/task/{taskId}/newRollback/config
2Host: dts.baidubce.com
3Authorization: authorization string
4{
5 "taskName": "dtsr5g818m9dclz0gvf6",
6 "openRollbackConfig": "true",
7 "dtsTaskPos": {
8 "type": "migration",
9 "dataType": [
10 "increment",
11 "schema",
12 "base"
13 ],
14 "taskName": "正向",
15 "srcConnection": {
16 "instanceType": "bcegateway",
17 "dbType": "mysql",
18 "region": "bj",
19 "dbHost": "172.16.1.37",
20 "dbPort": 3306,
21 "dbUser": "db1",
22 "dbPass": "db12345#",
23 "vpcShortId": "vpc-2a0giawvdben",
24 "subnetShortId": "sbn-ka9xp8yuj81n",
25 "zone": "cn-bd-c",
26 "field_whitelist": "",
27 "field_blacklist": ""
28 },
29 "dstConnection": {
30 "instanceType": "bcerds",
31 "dbType": "mysql",
32 "region": "bd",
33 "instanceId": "rds-U9MLckFU",
34 "sqlType": ""
35 },
36 "schemaMapping": [
37 {
38 "src": "lws.t",
39 "dst": "test1.t",
40 "type": "table"
41 }
42 ],
43 "granularity": "dbtb",
44 "incrIgnoreType":""
45 },
46 "dtsTaskNeg": {
47 "type": "migration",
48 "dataType": [
49 "increment"
50 ],
51 "taskName": "反向",
52 "srcConnection": {
53 "instanceType": "bcerds",
54 "dbType": "mysql",
55 "region": "bd",
56 "instanceId": "rds-U9MLckFU",
57 "sqlType": ""
58 },
59 "dstConnection": {
60 "instanceType": "bcegateway",
61 "dbType": "mysql",
62 "region": "bj",
63 "dbHost": "172.16.1.37",
64 "dbPort": 3306,
65 "dbUser": "db1",
66 "dbPass": "db12345#",
67 "vpcShortId": "vpc-2a0giawvdben",
68 "subnetShortId": "sbn-ka9xp8yuj81n",
69 "zone": "cn-bd-c",
70 "field_whitelist": "",
71 "field_blacklist": ""
72 },
73 "schemaMapping": [
74 {
75 "src": "lws.t",
76 "dst": "test1.t",
77 "type": "table"
78 }
79 ],
80 "granularity": "dbtb",
81 "incrIgnoreType":""
82 }
83}请求体参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| taskId | String | 是 | 任务ID | "dtsmxxxyyy" | URL参数 |
| taskName | String | 是 | 任务名称 | taskName | Request Body 参数 |
| openRollbackConfig | String | 是 | 是否打开反向任务配置 | true | Request Body 参数 |
| dtsTaskPos | String | 是 | 正向数据流 | dtsTaskPos | Request Body 参数 |
| dtsTaskNeg | String | 是 | 反向数据流 | dtsTaskNeg | Request Body 参数 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| dtsId | String | 是 | 任务ID | dtsxxxyyyzzz |
请求示例
JSON
1POST /v1/task/{taskId}/newRollback/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{
7 "taskName": "dtsr5g818m9dclz0gvf6",
8 "openRollbackConfig": "true",
9 "dtsTaskPos": {
10 "type": "migration",
11 "dataType": [
12 "increment",
13 "schema",
14 "base"
15 ],
16 "taskName": "正向",
17 "srcConnection": {
18 "instanceType": "bcegateway",
19 "dbType": "mysql",
20 "region": "bj",
21 "dbHost": "172.16.1.37",
22 "dbPort": 3306,
23 "dbUser": "db1",
24 "dbPass": "db12345#",
25 "vpcShortId": "vpc-2a0giawvdben",
26 "subnetShortId": "sbn-ka9xp8yuj81n",
27 "zone": "cn-bd-c",
28 "field_whitelist": "",
29 "field_blacklist": ""
30 },
31 "dstConnection": {
32 "instanceType": "bcerds",
33 "dbType": "mysql",
34 "region": "bd",
35 "instanceId": "rds-U9MLckFU",
36 "sqlType": ""
37 },
38 "schemaMapping": [
39 {
40 "src": "lws.t",
41 "dst": "test1.t",
42 "type": "table"
43 }
44 ],
45 "granularity": "dbtb",
46 "incrIgnoreType":""
47 },
48 "dtsTaskNeg": {
49 "type": "migration",
50 "dataType": [
51 "increment"
52 ],
53 "taskName": "反向",
54 "srcConnection": {
55 "instanceType": "bcerds",
56 "dbType": "mysql",
57 "region": "bd",
58 "instanceId": "rds-U9MLckFU",
59 "sqlType": ""
60 },
61 "dstConnection": {
62 "instanceType": "bcegateway",
63 "dbType": "mysql",
64 "region": "bj",
65 "dbHost": "172.16.1.37",
66 "dbPort": 3306,
67 "dbUser": "db1",
68 "dbPass": "db12345#",
69 "vpcShortId": "vpc-2a0giawvdben",
70 "subnetShortId": "sbn-ka9xp8yuj81n",
71 "zone": "cn-bd-c",
72 "field_whitelist": "",
73 "field_blacklist": ""
74 },
75 "schemaMapping": [
76 {
77 "src": "lws.t",
78 "dst": "test1.t",
79 "type": "table"
80 }
81 ],
82 "granularity": "dbtb",
83 "incrIgnoreType":""
84 }
85}响应示例
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}/rollback/precheck
2Host: dts.baidubce.com
3Authorization: authorization string 请求体参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| dtsId | String | 是 | 任务ID | "dtsxxxxyyy" | URL参数 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| success | Boolean | 是 | 是否成功 | true |
| result | Object | 是 | 前置检查结果集合 |
请求示例
JSON
1GET /v1/task/{dtsId}/rollback/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 "success": true,
5 "result": {
6 "posCheckResults": [//正向数据流
7 {
8 "name": "srcConnect",
9 "status": "ready",
10 "message": "源库无法连接, 请确认配置信息和源库状态是否正常",
11 "subscription": "检查数据传输服务是否能连通源数据源"
12 }
13 ],
14 "negCheckResults": [//反向数据流
15 {
16 "name": "dstConnect",
17 "status": "ready",
18 "message": "目标库无法连接, 请确认配置信息和目标库状态是否正常",
19 "subscription": "检查数据传输服务器是否能连通目的数据库"
20 }
21 ]
22 }
23}强制跳过前置检查
接口说明
强制跳过前置检查。
请求结构
JSON
1PUT /v1/task/{dtsId}?skipPrecheck
2Host: dts.baidubce.com
3Authorization: authorization string 请求体参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| dtsId | String | 是 | 单任务ID | dtsmxxxyyy | 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 "result" : { },
4 "success" : true
5}暂停任务
接口说明
运行中的任务可以暂停。
请求结构
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 "result" : { },
4 "success" : true
5}结束任务
接口说明
结束任务。
请求结构
JSON
1POST /v1/task/{dtsId}/shutdown
2Host: dts.baidubce.com
3Authorization: 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 "result" : { },
4 "success" : true
5}释放任务
接口说明
释放并删除任务。
请求结构
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}一键反向延迟检查
接口说明
一键反向延迟检查。
请求结构
JSON
1POST /v1/task/{dtsId}/newRollbackCheck
2Host: dts.baidubce.com
3Authorization: authorization string 请求体参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| dtsId | String | 是 | 任务ID | dtsxxxxyyy | URL参数 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| success | Boolean | 是 | 是否成功 | true |
| result | Object | 否 | null |
请求示例
JSON
1POST /v1/task/{dtsId}/newRollbackCheck
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 "success": true,
4 "status": 200,
5 "result": {
6 "data": [
7 {
8 "dtsId": "dtsm5ktdl7vu9twkx7oq",
9 "delay": "2"
10 }
11 ]
12 }
13}启动一键反向
接口说明
启动一键反向，当一键反向的正反向任务处于增量运行中时(subStatus中“I”:"running")，调用此接口。
请求结构
JSON
1POST /v1/task/{dtsId}/rollback
2Host: dts.baidubce.com
3Authorization: authorization string 请求体参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| dtsId | String | 是 | 任务ID | dtsxxxxyyy | URL参数 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| success | Boolean | 是 | 是否成功 | true |
| result | Object | 否 | null |
请求示例
JSON
1POST /v1/task/{dtsId}/rollback
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}查询任务信息
接口说明
查看指定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": "dtsr5g818m9dclz0gvf6",
4 "status": "running",
5 "region": "bd->bd",
6 "dtsIdPos": "dtsmub011wnqq29iwnso",
7 "dtsIdNeg": "dtsmh1890duax9ri923u",
8 "dtsTaskPos": {
9 "dtsId": "dtsmub011wnqq29iwnso",
10 "taskName": "正向",
11 "status": "running",
12 "dataType": [
13 "schema",
14 "base",
15 "increment"
16 ],
17 "region": "bd->bd",
18 "createTime": "2022-12-01T07:45:14Z",
19 "srcConnection": {
20 "instanceType": "bcegateway",
21 "dbType": "mysql",
22 "region": "bj",
23 "dbHost": "172.16.1.37",
24 "dbPort": 3306,
25 "dbUser": "db1",
26 "dbPass": "",
27 "vpcShortId": "vpc-2a0giawvdben",
28 "subnetShortId": "sbn-ka9xp8yuj81n",
29 "zone": "cn-bd-c",
30 "field_whitelist": "",
31 "field_blacklist": ""
32 },
33 "dstConnection": {
34 "instanceType": "bcerds",
35 "dbType": "mysql",
36 "region": "bd",
37 "instanceId": "rds-U9MLckFU",
38 "sqlType": ""
39 },
40 "schemaMapping": [
41 {
42 "type": "table",
43 "src": "lws.t",
44 "dst": "lws.t"
45 }
46 ],
47 "granularity": "dbtb",
48 "initPosition": {
49 "type": "gtidset",
50 "position": "54638621-1505-11eb-bfa0-6c92bf3bcc61:1-29122194"
51 },
52 "subStatus": [
53 {
54 "s": "closed",
55 "b": "closed",
56 "i": "running"
57 }
58 ],
59 "dynamicInfo": {
60 "schema": [
61 {
62 "current": "1",
63 "count": "1",
64 "speed": "0.100000",
65 "expectFinishTime": "0"
66 }
67 ],
68 "base": [
69 {
70 "current": "2",
71 "count": "2",
72 "speed": "0.200000",
73 "expectFinishTime": "0"
74 }
75 ],
76 "increment": {
77 "delay": 0, // 延迟为0时表示增量同步追平
78 "position": "54638621-1505-11eb-bfa0-6c92bf3bcc61:1-29122194"// 增量同步位点与源端一致时表示增量同步追平
79 }
80 },
81 "statistic": {
82 "readSpeed": "",
83 "writeSpeed": ""
84 },
85 "errmsg": "",
86 "subDataScope": {
87 "startTime": "",
88 "endTime": ""
89 }
90 },
91 "dtsTaskNeg": {
92 "dtsId": "dtsmh1890duax9ri923u",
93 "taskName": "dtsmh1890duax9ri923u",
94 "status": "paused",
95 "dataType": [
96 "increment"
97 ],
98 "region": "bd->bd",
99 "createTime": "2022-12-01T07:45:14Z",
100 "srcConnection": {
101 "dbServer": "",
102 "instanceType": "bcerds",
103 "region": "bd",
104 "dbType": "mysql",
105 "dbUser": "_dts_trans_",
106 "dbPass": "",
107 "dbPort": 3306,
108 "dbHost": "100.80.205.40",
109 "instanceId": "rdsmizrhd984cx8",
110 "instanceShortId": "rds-U9MLckFU",
111 "maxRetryTime": "720",
112 "field_whitelist": "",
113 "field_blacklist": ""
114 },
115 "dstConnection": {
116 "dbServer": "",
117 "instanceType": "public",
118 "region": "bd",
119 "dbType": "mysql",
120 "dbUser": "admin",
121 "dbPass": "",
122 "dbPort": 3308,
123 "dbHost": "10.156.64.44",
124 "instanceId": "",
125 "sqlType": "",
126 "maxRetryTime": "720",
127 "supportOnlineDDL": "false"
128 },
129 "schemaMapping": [
130 {
131 "type": "table",
132 "src": "lws.t",
133 "dst": "lws.t",
134 "where": "",
135 "sqlType": null,
136 "fieldBlacklist": null,
137 "fieldWhitelist": null,
138 "field": null
139 }
140 ],
141 "initPosition": {
142 "type": null,
143 "position": ""
144 },
145 "subStatus": [],
146 "statistic": {
147 "readSpeed": "",
148 "writeSpeed": ""
149 },
150 "errmsg": "",
151 "granularity": "dbtb",
152 "subDataScope": {
153 "startTime": "",
154 "endTime": ""
155 }
156 },
157 "createTime": "2022-12-01T07:45:14Z"
158 "payInfo": {
159 "productType": "postpay",
160 "sourceInstanceType": "OffBce",
161 "targetInstanceType": "OnBce",
162 "crossRegionTag": 1,
163 "createTime": 1669880714000,
164 "standard": "Large",
165 "endTime": null
166 },
167 "incrNetType": "large",
168 "netType": "large",
169 "incrIgnoreType": null
170}