专线迁移Redis Cluster迁移到云数据库Redis企业集群版-一键反向
更新时间:2023-10-27
创建任务
接口说明
创建任务。
请求结构
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": "redisCluster",
17 "sliceNum": 2,
18 "region": "bd",
19 "vpcShortId": "vpc-784a9yx6dj21",
20 "subnetShortId": "sbn-fgjg9kup7fub",
21 "zone": "cn-fwh-a"
22 },
23 "dst": {
24 "instanceType": "bcescs",
25 "dbType": "redisCluster",
26 "region": "bd"
27 }
28 }
29}
请求体参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
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 | Integer | 否 | 分片数量 | 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": "redisCluster",
18 "sliceNum": 2,
19 "region": "bd",
20 "vpcShortId": "vpc-784a9yx6dj21",
21 "subnetShortId": "sbn-fgjg9kup7fub",
22 "zone": "cn-fwh-a"
23 },
24 "dst": {
25 "instanceType": "bcescs",
26 "dbType": "redisCluster",
27 "region": "bd"
28 }
29 }
30}
响应示例
JSON
1HTTP/1.1 200 OK
2{
3 "dtsTasks": [{
4 "dtsId": "dtsrelbh81lx8xicuacs"
5 }]
6}
配置任务
接口说明
配置任务。
请求结构
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 "dtsId": "dtsrelbh81lx8xicuacs",
7 "taskName": "专线迁移的Redis Cluster迁移到SCS企业集群版(一键反向)",
8 "openRollbackConfig": "true",
9 "dtsTaskPos": {
10 "type": "migration",
11 "dtsGroupName": "正向",
12 "dataType": [
13 "increment",
14 "base"
15 ],
16 "srcConnection": {
17 "instanceType": "bcegateway",
18 "dbType": "redisCluster",
19 "region": "bj",
20 "clusterTopo": "172.0.0.1:6379,172.0.0.2:6379;172.0.1.1:6379,172.0.1.2:6379;172.0.2.1:6379,172.0.2.2:6379",
21 "dbPass": "",
22 "vpcShortId": "vpc-2a0giawvdben",
23 "subnetShortId": "sbn-fgjg9kup7fub",
24 "zone": "cn-fwh-a",
25 "positionStrategy": "fail"
26 },
27 "dstConnection": {
28 "instanceType": "bcescs",
29 "dbType": "redisCluster",
30 "region": "bj",
31 "instanceId": "scs-bj-ohfyvdqyxkwg",
32 "dbPass": ""
33 },
34 "schemaMapping": [],
35 "granularity": "instance"
36 },
37 "dtsTaskNeg": {
38 "type": "migration",
39 "dtsGroupName": "反向",
40 "dataType": [
41 "increment"
42 ],
43 "srcConnection": {
44 "instanceType": "bcescs",
45 "dbType": "redisCluster",
46 "region": "bj",
47 "instanceId": "scs-bj-ohfyvdqyxkwg",
48 "srcDstFlag": "dst",
49 "dbServer": ""
50 },
51 "dstConnection": {
52 "instanceType": "bcegateway",
53 "dbType": "redisCluster",
54 "region": "bj",
55 "clusterTopo": "172.0.0.1:6379,172.0.0.2:6379;172.0.1.1:6379,172.0.1.2:6379;172.0.2.1:6379,172.0.2.2:6379",
56 "dbPass": "",
57 "zone": "cn-fwh-a",
58 "subnetShortId": "sbn-fgjg9kup7fub",
59 "vpcShortId": "vpc-2a0giawvdben"
60 },
61 "schemaMapping": [],
62 "granularity": "instance"
63 }
64}
请求体参数
参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
---|---|---|---|---|---|
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 "dtsId": "dtsrelbh81lx8xicuacs",
7 "taskName": "专线迁移的Redis Cluster迁移到SCS企业集群版(一键反向)",
8 "openRollbackConfig": "true",
9 "dtsTaskPos": {
10 "type": "migration",
11 "dtsGroupName": "正向",
12 "dataType": [
13 "increment",
14 "base"
15 ],
16 "srcConnection": {
17 "instanceType": "bcegateway",
18 "dbType": "redisCluster",
19 "region": "bj",
20 "clusterTopo": "172.0.0.1:6379,172.0.0.2:6379;172.0.1.1:6379,172.0.1.2:6379;172.0.2.1:6379,172.0.2.2:6379",
21 "dbPass": "",
22 "vpcShortId": "vpc-2a0giawvdben",
23 "subnetShortId": "sbn-fgjg9kup7fub",
24 "zone": "cn-fwh-a",
25 "positionStrategy": "fail"
26 },
27 "dstConnection": {
28 "instanceType": "bcescs",
29 "dbType": "redisCluster",
30 "region": "bj",
31 "instanceId": "scs-bj-ohfyvdqyxkwg",
32 "dbPass": ""
33 },
34 "schemaMapping": [],
35 "granularity": "instance"
36 },
37 "dtsTaskNeg": {
38 "type": "migration",
39 "dtsGroupName": "反向",
40 "dataType": [
41 "increment"
42 ],
43 "srcConnection": {
44 "instanceType": "bcescs",
45 "dbType": "redisCluster",
46 "region": "bj",
47 "instanceId": "scs-bj-ohfyvdqyxkwg",
48 "srcDstFlag": "dst",
49 "dbServer": ""
50 },
51 "dstConnection": {
52 "instanceType": "bcegateway",
53 "dbType": "redisCluster",
54 "region": "bj",
55 "clusterTopo": "172.0.0.1:6379,172.0.0.2:6379;172.0.1.1:6379,172.0.1.2:6379;172.0.2.1:6379,172.0.2.2:6379",
56 "dbPass": "",
57 "zone": "cn-fwh-a",
58 "subnetShortId": "sbn-fgjg9kup7fub",
59 "vpcShortId": "vpc-2a0giawvdben"
60 },
61 "schemaMapping": [],
62 "granularity": "instance"
63 }
64}
响应示例
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{
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 "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 //一键反向dtsrelbh81lx8xicuacs任务详情
4 "taskName": "dtsrelbh81lx8xicuacs",
5 "status": "ready,
6 "region": "bj->bj",
7 "createTime": "2022-09-13T07:52:30Z",
8 "dtsIdPos": "dtsgopxwg5swes7b25ek",
9 "dtsIdNeg": "dtsgong72g3o6pl6om18",
10 "dtsTaskPos": { //正向数据流(任务组)dtsgopxwg5swes7b25ek详情
11 "dtsGroupName": "dtsrelbh81lx8xicuacs",
12 "dtsGroupId": "dtsgopxwg5swes7b25ek",
13 "status": "ready",
14 "dataType": [
15 "base",
16 "increment"
17 ],
18 "region": "bj",
19 "createTime": "2022-09-13T07:52:31Z",
20 "srcConnection": {
21 "instanceType": "bcegateway",
22 "region": "bj",
23 "dbType": "redisCluster",
24 "sliceNum": "2",
25 "clusterTopo": "172.0.0.1:6379,172.0.0.2:6379;172.0.1.1:6379,172.0.1.2:6379;172.0.2.1:6379,172.0.2.2:6379",
26 "dbPass": "",
27 "vpcId": "9556bf45-5867-4495-83c5-bd945b782503",
28 "vpcName": "zhaixinrui",
29 "vpcCidr": "172.16.0.0/16",
30 "vpcShortId": "vpc-it3v6qt3jhvj",
31 "positionStrategy": "fail"
32 },
33 "dstConnection": {
34 "instanceType": "bcescs",
35 "region": "bj",
36 "dbType": "redisCluster",
37 "instanceId": "scs-bj-ohfyvdqyxkwg",
38 "dbPass": ""
39 },
40 "schemaMapping": [],
41 "incrNetType": "large",
42 "netType": null,
43 "remark": "",
44 "dtsTasks": [ //子任务dtsm5imulov4tlqsesqa详情
45 {
46 "dtsId": "dtsm5imulov4tlqsesqa",
47 "taskName": "son of dtsgopxwg5swes7b25ek",
48 "status": "ready",
49 "srcConnection": {
50 "instanceType": "bcegateway",
51 "region": "bj",
52 "dbType": "redis",
53 "dbHost": "10.18.140.78",
54 "dbPort": 8,
55 "dbPass": "",
56 "vpcId": "9556bf45-5867-4495-83c5-bd945b782503",
57 "backendIp": "172.16.2.23",
58 "backendPort": 6379,
59 "vpcEndpointId": "afef67ff-8731-4aac-abed-27b30b6a0ca2",
60 "positionStrategy": "fail"
61 },
62 "dstConnection": {
63 "instanceType": "bcescs",
64 "region": "bj",
65 "dbType": "redis",
66 "instanceId": "scs-bj-ohfyvdqyxkwg_proxy_2"
67 },
68 "dynamicInfo": {},
69 "message": "",
70 "schemaMapping": [],
71 "createTime": "2022-09-13T08:04:38Z",
72 "dataType": [
73 "base",
74 "increment"
75 ],
76 "subStatus": []
77 }
78 ]
79 },
80 "dtsTaskNeg": { //反向数据流(任务组)dtsgong72g3o6pl6om18详情
81 "dtsGroupName": "dtsrelbh81lx8xicuacs",
82 "dtsGroupId": "dtsgong72g3o6pl6om18",
83 "status": "ready",
84 "dataType": [
85 "increment"
86 ],
87 "region": "bj",
88 "createTime": "2022-09-13T07:52:31Z",
89 "srcConnection": {
90 "instanceType": "bcescs",
91 "region": "bj",
92 "dbType": "redisCluster",
93 "instanceId": "scs-bj-ohfyvdqyxkwg",
94 "dbPass": ""
95 },
96 "dstConnection": {
97 "instanceType": "bcegateway",
98 "region": "bj",
99 "dbType": "redisCluster",
100 "sliceNum": "2",
101 "clusterTopo": "172.0.0.1:6379,172.0.0.2:6379;172.0.1.1:6379,172.0.1.2:6379;172.0.2.1:6379,172.0.2.2:6379",
102 "dbPass": "",
103 "vpcId": "9556bf45-5867-4495-83c5-bd945b782503",
104 "vpcName": "zhaixinrui",
105 "vpcCidr": "172.16.0.0/16",
106 "vpcShortId": "vpc-it3v6qt3jhvj",
107 "positionStrategy": "fail"
108 },
109 "schemaMapping": [],
110 "remark": "",
111 "dtsTasks": [//子任务dtsmdf98gso72lm0qasd详情
112 {
113 "dtsId": "dtsmdf98gso72lm0qasd",
114 "taskName": "son of dtsgong72g3o6pl6om18",
115 "status": "ready",
116 "srcConnection": {
117 "instanceType": "bcescs",
118 "region": "bj",
119 "dbType": "redis",
120 "instanceId": "scs-bj-ohfyvdqyxkwg-0",
121 "dbPass": "",
122 },
123 "dstConnection": {
124 "instanceType": "bcegateway",
125 "region": "bj",
126 "dbType": "redis",
127 "dbHost": "10.18.140.78",
128 "dbPort": 8,
129 "dbPass": "",
130 "vpcId": "9556bf45-5867-4495-83c5-bd945b782503",
131 "backendIp": "172.16.2.23",
132 "backendPort": 6379,
133 "vpcEndpointId": "afef67ff-8731-4aac-abed-27b30b6a0ca2",
134 "positionStrategy": "fail"
135 },
136 "dynamicInfo": {},
137 "message": "",
138 "schemaMapping": [],
139 "createTime": "2022-09-13T08:04:39Z",
140 "dataType": [
141 "increment"
142 ],
143 "subStatus": []
144 }
145 ]
146 },
147 "payInfo": {
148 "productType": "postpay",
149 "sourceInstanceType": "OffBce",
150 "targetInstanceType": "OnBce",
151 "crossRegionTag": 1,
152 "createTime": 1663055551000,
153 "standard": "Large",
154 "endTime": null
155 },
156 "incrNetType": "large",
157 "netType": "large",
158 "openRollbackConfig": "false"
159}