专线迁移MongoDB副本集迁移到云数据库MongoDB副本集-一键反向
更新时间:2023-10-18
创建任务
接口说明
创建任务。
请求结构
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": "mongodb",
17 "region": "bd",
18 "vpcShortId": "vpc-2a0giawvdben",
19 "subnetShortId": "sbn-ka9xp8yuj81n",
20 "zone": "cn-bd-c"
21 },
22 "dst": {
23 "instanceType": "bcedocdb",
24 "dbType": "mongodb",
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": "mongodb",
18 "region": "bd",
19 "vpcShortId": "vpc-2a0giawvdben",
20 "subnetShortId": "sbn-ka9xp8yuj81n",
21 "zone": "cn-bd-c"
22 },
23 "dst": {
24 "instanceType": "bcedocdb",
25 "dbType": "mongodb",
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": "专线迁移的MongoDB副本集迁移到云数据库MongoDB(一键反向)",
6 "openRollbackConfig": "true",
7 "dtsTaskPos": {
8 "type": "migration",
9 "dataType": [
10 "schema",
11 "increment",
12 "base"
13 ],
14 "taskName": "正向",
15 "srcConnection": {
16 "instanceType": "bcegateway",
17 "dbType": "mongodb",
18 "region": "bj",
19 "dbServer": "172.16.1.70:3306",
20 "dbUser": "root",
21 "dbPass": "root123#",
22 "vpcShortId": "vpc-2a0giawvdben",
23 "subnetShortId": "sbn-ka9xp8yuj81n",
24 "zone": "cn-bd-c",
25 },
26 "dstConnection": {
27 "instanceType": "bcedocdb",
28 "dbType": "mongodb",
29 "region": "bj",
30 "instanceId": "m-JToNgx",
31 "dbServer": "",
32 "dbUser": "root",
33 "dbPass": "root123#"
34 },
35 "schemaMapping": [],
36 "granularity": "instance"
37 },
38 "dtsTaskNeg": {
39 "type": "migration",
40 "dataType": [
41 "increment"
42 ],
43 "taskName": "反向",
44 "srcConnection": {
45 "instanceType": "bcedocdb",
46 "dbType": "mongodb",
47 "region": "bj",
48 "instanceId": "m-JToNgx",
49 "dbServer": "",
50 "dbUser": "root",
51 "dbPass": "root123#"
52 },
53 "dstConnection": {
54 "instanceType": "bceet",
55 "dbType": "mongodb",
56 "region": "bj",
57 "dbServer": "172.16.1.70:3306",
58 "dbUser": "root",
59 "dbPass": "root123#",
60 "vpcShortId": "vpc-2a0giawvdben",
61 "subnetShortId": "sbn-ka9xp8yuj81n",
62 "zone": "cn-bd-c"
63 },
64 "schemaMapping": [],
65 "granularity": "instance"
66 }
67}
请求体参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
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 "taskName": "专线迁移的MongoDB副本集迁移到云数据库MongoDB(一键反向)",
7 "openRollbackConfig": "true",
8 "dtsTaskPos": {
9 "type": "migration",
10 "dataType": [
11 "schema",
12 "increment",
13 "base"
14 ],
15 "taskName": "正向",
16 "srcConnection": {
17 "instanceType": "bcegateway",
18 "dbType": "mongodb",
19 "region": "bj",
20 "dbServer": "172.16.1.70:3306",
21 "dbUser": "root",
22 "dbPass": "root123#",
23 "vpcShortId": "vpc-2a0giawvdben",
24 "subnetShortId": "sbn-ka9xp8yuj81n",
25 "zone": "cn-bd-c",
26 },
27 "dstConnection": {
28 "instanceType": "bcedocdb",
29 "dbType": "mongodb",
30 "region": "bj",
31 "instanceId": "m-JToNgx",
32 "dbServer": "",
33 "dbUser": "root",
34 "dbPass": "root123#"
35 },
36 "schemaMapping": [],
37 "granularity": "instance"
38 },
39 "dtsTaskNeg": {
40 "type": "migration",
41 "dataType": [
42 "increment"
43 ],
44 "taskName": "反向",
45 "srcConnection": {
46 "instanceType": "bcedocdb",
47 "dbType": "mongodb",
48 "region": "bj",
49 "instanceId": "m-JToNgx",
50 "dbServer": "",
51 "dbUser": "root",
52 "dbPass": "root123#"
53 },
54 "dstConnection": {
55 "instanceType": "bceet",
56 "dbType": "mongodb",
57 "region": "bj",
58 "dbServer": "172.16.1.70:3306",
59 "dbUser": "root",
60 "dbPass": "root123#",
61 "vpcShortId": "vpc-2a0giawvdben",
62 "subnetShortId": "sbn-ka9xp8yuj81n",
63 "zone": "cn-bd-c"
64 },
65 "schemaMapping": [],
66 "granularity": "instance"
67 }
68}
响应示例
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 "result" : { },
4 "success" : true
5}
查询前置检查结果
接口说明
任务启动前的前置检查,包括连通性,对象存在性,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{
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{
4 "result" : { },
5 "success" : true
6}
一键反向延迟检查
接口说明
一键反向延迟检查。
请求结构
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{
4 "success": true,
5 "status": 200,
6 "result": {
7 "data": [
8 {
9 "dtsId": "dtsm5ktdl7vu9twkx7oq",
10 "delay": "2"
11 }
12 ]
13 }
14}
启动一键反向
接口说明
启动一键反向,当一键反向的正反向任务处于增量运行中时(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": "专线迁移的MongoDB副本集迁移到云数据库MongoDB(一键反向)",
4 "status": "running",
5 "region": "bd->bd",
6 "createTime": "2022-12-02T03:17:39Z",
7 "dtsIdPos": "dtsmzfwjdr5xz5qeushd",
8 "dtsIdNeg": "dtsm2r20hh4had4q8op1",
9 "dtsTaskPos": {
10 "dtsId": "dtsmzfwjdr5xz5qeushd",
11 "taskName": "正向",
12 "status": "running",
13 "dataType": [
14 "schema",
15 "base",
16 "increment"
17 ],
18 "region": "bd->bd",
19 "createTime": "2022-12-02T03:17:39Z",
20 "srcConnection": {
21 "instanceType": "bcegateway",
22 "region": "bd",
23 "dbType": "mongodb",
24 "dbServer": "100.80.143.80:189",
25 "dbHost": "",
26 "dbPort": "",
27 "dbUser": "root",
28 "dbPass": "",
29 "authDB": "admin",
30 "vpcShortId": "vpc-2a0giawvdben",
31 "subnetShortId": "sbn-ka9xp8yuj81n",
32 "zone": "cn-bd-c",
33 "vpcId": "1cd2dd00-b2c8-4053-9550-594a2991cc6e",
34 "vpcName": "默认私有网络",
35 "vpcCidr": "172.16.0.0/16"
36 },
37 "dstConnection": {
38 "instanceType": "bcedocdb",
39 "region": "bd",
40 "dbType": "mongodb",
41 "instanceId": "m-OucBSC",
42 "dbHost": "",
43 "dbPort": "",
44 "dbUser": "root",
45 "dbPass": "",
46 "authDB": "admin"
47 },
48 "schemaMapping": [],
49 "granularity": "instance",
50 "subStatus": [
51 {
52 "s": "closed",
53 "b": "closed",
54 "i": "running"
55 }
56 ],
57 "dynamicInfo": {
58 "schema": [
59 {
60 "current": "-1",
61 "count": "-1",
62 "speed": "-1",
63 "expectFinishTime": "-1"
64 }
65 ],
66 "base": [
67 {
68
69"count": "321597",
70 "current": "321597",
71 "finishTableCount": "1",
72 "totalTableCount": "1",
73 "expectFinishTime": -1,
74 "speed": -1
75 }
76 ],
77 "increment": {
78 "delay": 0,
79 "position": "1669951546,1"
80 }
81 },
82 "statistic": {
83 "readSpeed": "0.00",
84 "writeSpeed": "0.00"
85 },
86 "errmsg": ""
87 "subDataScope": {
88 "startTime": "",
89 "endTime": ""
90 },
91 "incrNetType": "large",
92 "netType": "large",
93 "incrIgnoreType": "",
94 "remark": ""
95 },
96 "dtsTaskNeg": {
97 "dtsId": "dtsm2r20hh4had4q8op1",
98 "taskName": "反向",
99 "status": "paused",
100 "dataType": [
101 "increment"
102 ],
103 "region": "bd->bd",
104 "createTime": "2022-12-02T03:17:40Z",
105 "srcConnection": {
106 "instanceType": "bcedocdb",
107 "region": "bd",
108 "dbType": "mongodb",
109 "instanceId": "m-OucBSC",
110 "dbHost": "",
111 "dbPort": "",
112 "dbUser": "root",
113 "dbPass": "",
114 "authDB": "admin"
115 },
116 "dstConnection": {
117 "instanceType": "bcegateway",
118 "region": "bd",
119 "dbType": "mongodb",
120 "dbServer": "100.80.143.80:189",
121 "dbUser": "root",
122 "dbHost": "",
123 "dbPort": "",
124 "dbPass": "",
125 "authDB": "admin",
126 "vpcShortId": "vpc-2a0giawvdben",
127 "subnetShortId": "sbn-ka9xp8yuj81n",
128 "zone": "cn-bd-c",
129 "vpcId": "1cd2dd00-b2c8-4053-9550-594a2991cc6e",
130 "vpcName": "默认私有网络",
131 "vpcCidr": "172.16.0.0/16"
132 },
133 "schemaMapping": [],
134 "granularity": "instance",
135 "subStatus": [],
136 "statistic": {
137 "readSpeed": "",
138 "writeSpeed": ""
139 },
140 "errmsg": "",
141 "subDataScope": {
142 "startTime": "",
143 "endTime": ""
144 },
145 "incrNetType": "large",
146 "netType": "large",
147 "incrIgnoreType": "",
148 "remark": ""
149 },
150 "payInfo": {
151 "productType": "postpay",
152 "sourceInstanceType": "OffBce",
153 "targetInstanceType": "OnBce",
154 "crossRegionTag": 1,
155 "createTime": 1669951060000,
156 "standard": "Large",
157 "endTime": null
158 },
159 "incrNetType": "large",
160 "netType": "large",
161 "openRollbackConfig": "true"
162}