专线迁移Redis标准版迁移到云数据库Redis标准版
更新时间：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 "orderInfo": {
13 "src": {
14 "instanceType": "bcegateway",
15 "dbType": "redis",
16 "region": "bd",
17 "vpcShortId": "vpc-8mhenwrw1k6s",
18 "subnetShortId": "sbn-xyndrgbzemup",
19 "zone": "cn-bd-a"
20 },
21 "dst": {
22 "instanceType": "bcescs",
23 "dbType": "redis",
24 "region": "bd"
25 }
26 }
27}请求体参数
请求参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| 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
3ContentType: 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 "orderInfo": {
14 "src": {
15 "instanceType": "bcegateway",//源端接入类型bcegateway专线迁移
16 "dbType": "redis",//源端数据类型
17 "region": "bd",//源端地域
18 "vpcShortId": "vpc-8mhenwrw1k6s",// 接入类型为bcegateway时，需要指定VPC短ID
19 "subnetShortId": "sbn-xyndrgbzemup",//接入类型为bcegateway时，需要指定子网短ID
20 "zone": "cn-bd-a"//接入类型为bcegateway时，需要指定可用区
21 },
22 "dst": {
23 "instanceType": "bcescs",//目标端接入类型bcescs云数据库 DocDB for Redis
24 "dbType": "redis",//目标端数据类型
25 "region": "bd"//目标端地域
26 }
27 }
28}响应示例
JSON
1HTTP/1.1 200 OK
2{
3 "dtsTasks": [
4 {
5 "dtsId": "dtsm0eoplf9kemw0z1yi"
6 }
7 ]
8}配置任务
接口说明
配置任务。
请求结构
JSON
1POST /v1/task/{dtsId}/config
2Host: dts.baidubce.com
3Authorization: authorization string
4{
5 "type": "migration",
6 "taskName": "专线迁移的Redis标准版迁移到云数据库SCS for Redis标准版",
7 "dataType": [
8 "increment",
9 "base"
10 ],
11 "srcConnection": {
12 "instanceType": "bcegateway",
13 "dbType": "redis",
14 "region": "bd",
15 "dbHost": "10.136.158.21",
16 "dbPort": "3333",
17 "dbPass": "",
18 "vpcShortId": "vpc-2a0giawvdben",
19 "subnetShortId": "sbn-ka9xp8yuj81n",
20 "zone": "cn-bd-c",
21 "positionStrategy": "fail"
22 },
23 "dstConnection": {
24 "instanceType": "bcescs",
25 "dbType": "redis",
26 "region": "bd",
27 "instanceId": "scs-bdbl-jcoovhwewnwi",
28 "dbPass": ""
29 },
30 "schemaMapping": [],
31 "granularity": "instance"
32}请求体参数
请求参数
| 参数名称 | 参数类型 | 是否必选 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| 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 |
请求示例
JSON
1POST /v1/task/{dtsId}/config
2Host: dts.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
5{
6 "type": "migration",
7 "taskName": "专线迁移的Redis标准版迁移到云数据库SCS for Redis标准版",
8 "dataType": [//传输数据类型数组（base：全量迁移；increment：增量迁移）
9 "increment",
10 "base"
11 ],
12 "srcConnection": {
13 "instanceType": "bcegateway",
14 "dbType": "redis",
15 "region": "bd",
16 "dbHost": "10.136.158.21",
17 "dbPort": "3333",
18 "dbPass": "",
19 "vpcShortId": "vpc-2a0giawvdben",
20 "subnetShortId": "sbn-ka9xp8yuj81n",
21 "zone": "cn-bd-c",
22 "positionStrategy": "fail"//同步点失效的处理策略:fail(同步点失效时直接报任务失败)；base(同步点失效时自动重新开始全量和增量迁移)
23 },
24 "dstConnection": {
25 "instanceType": "bcescs",
26 "dbType": "redis",
27 "region": "bd",
28 "instanceId": "scs-bdbl-jcoovhwewnwi",
29 "dbPass": ""
30 },
31 "schemaMapping": [],
32 "granularity": "instance"//传输任务的粒度（instance：实例级）
33
34}响应示例
JSON
1HTTP/1.1 200 OK
2{
3 "dtsId" : "dtsxxxyyyzzz"
4}前置检查
接口说明
当配置完任务，开始前置检查。
请求结构
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：appplication/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}/precheck
2Host: dts.baidubce.com
3Authorization: authorization string 请求体参数
请求参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| dtsId | String | 是 | 任务ID | "dtsxxxxyyy" | URL参数 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| success | Boolean | 是 | 是否成功 | true |
| result | PreCheckResultItem[] | 是 | 前置检查结果集合 |
PreCheckResultItem字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| name | String | 是 | 名称 | srcOracleConnect |
| subscription | String | 是 | 描述 | 检查数据传输服务器是否能连通源数据库 |
| message | String | 是 | 提示语 | |
| status | String | 是 | 状态 | pass |
请求示例
JSON
1GET /v1/task/{dtsId}/precheck
2Host: dts.baidubce.com
3Content-Type：appplication/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 "name" : "srcOracleConnect",
5 "subscription" : "检查数据传输服务器是否能连通源数据库",
6 "message" : "message",
7 "status" : "pass"
8 }, {
9 "name" : "srcOracleConnect",
10 "subscription" : "检查数据传输服务器是否能连通源数据库",
11 "message" : "message",
12 "status" : "pass"
13 } ],
14 "success" : true
15}强制跳过前置检查
接口说明
强制跳过前置检查。
请求结构
JSON
1PUT /v1/task/{dtsId}?skipPrecheck
2Host: dts.baidubce.com
3Content-Type：appplication/json
4Authorization: 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 |
请求示例
JSON
1PUT /v1/task/{dtsId}?skipPrecheck
2Host: dts.baidubce.com
3Content-Type：appplication/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}/start
2Host: dts.baidubce.com
3Content-Type：appplication/json
4Authorization: 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 |
请求示例
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: 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}查询任务信息
接口说明
查看指定ID的数据传输任务信息。
请求结构
JSON
1GET /v1/task/{dtsId}
2Host: dts.baidubce.com
3Content-Type: application/json
4Authorization: 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 "dtsId": "dtsm0eoplf9kemw0z1yi",
4 "taskName": "专线迁移的Redis标准版迁移到云数据库SCS for Redis标准版",
5 "status": "running",
6 "dataType": [
7 "base",
8 "increment"
9 ],
10 "region": "bj",
11 "createTime": "2022-09-13T07:03:19Z",
12 "srcConnection": {
13 "instanceType": "bcegateway",
14 "region": "bj",
15 "dbType": "redis",
16 "dbHost": "172.16.1.73",
17 "dbPort": 3306,
18 "dbUser": "",
19 "dbPass": "",
20 "instanceId": "",
21 "vpcId": "9556bf45-5867-4495-83c5-bd945b782503",
22 "vpcName": "zhaixinrui",
23 "vpcCidr": "172.16.0.0/16",
24 "vpcShortId": "vpc-it3v6qt3jhvj",
25 "subnetShortId": "sbn-ka9xp8yuj81n",
26 "zone": "cn-bd-c",
27 "backendIp": "172.16.1.73",
28 "backendPort": 3306,
29 "vpcEndpointId": "03227b7a-0441-4937-b82a-f1d0a773b498",
30 "positionStrategy": "fail"
31 },
32 "dstConnection": {
33 "instanceType": "bcescs",
34 "region": "bj",
35 "dbType": "redis",
36 "dbHost": "10.7.80.198",
37 "dbPort": 3306,
38 "dbUser": "",
39 "dbPass": "",
40 "instanceId": ""
41 },
42 "schemaMapping": [],
43 "granularity": "instance",
44 "subStatus": [
45 {
46 "b": "closed",//全量
47 "i": "running"//增量
48 }
49 ],
50 "dynamicInfo":{
51 "increment":{
52
53"delay":"1", //延迟信息, 单位为秒。延迟为0时表示增量同步追平
54 "position":"12345"//增量同步位点。增量同步点与源端一致时表示增量同步追平
55 },
56 "base" : {
57 "current" : "60000", // 已迁移数据行数
58 "count" : "150000", // 迁移总数据行数
59 "speed" : "1500", // 迁移速度
60 "expectFinishTime" : "87000"// 预测剩余时间(s)
61 }
62 },
63 "statistic": {
64 "readSpeed": "0.00",//读取速率, 行/s
65 "writeSpeed": "0.00"//写入速率, 行/s
66 },
67 "subDataScope": {
68 "startTime": "",
69 "endTime": ""
70 },
71 "payInfo": {
72 "productType": "postpay",
73 "sourceInstanceType": "OffBce",
74 "targetInstanceType": "OnBce",
75 "crossRegionTag": 1,
76 "createTime": 1663052601000,
77 "standard": "Large",
78 "endTime": null
79 },
80 "incrNetType": "large",
81 "netType": "large"
82}查询任务列表
接口说明
查看所有数据传输任务列表
请求结构
JSON
1POST /v1/task/list
2Host: dts.baidubce.com
3Authorization: authorization string
4{
5 "maxKeys" : 15,
6 "marker" : "dtsmxxxyyyzzz",
7 "type" : "migration"
8}请求参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| 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 |
请求示例
JSON
1POST /v1/task/list
2Host: dts.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
5{
6 "maxKeys" : 15,
7 "marker" : "dtsmxxxyyyzzz",
8 "type" : "migration"
9}响应示例
JSON
1HTTP/1.1 200 OK
2{
3 "nextMarker": "dtsmmcgm8tfn91kjdx6l",
4 "marker": null,
5 "maxKeys": 10,
6 "isTruncated": true,
7 "task": [
8 {
9 "dtsId": "dtsmmcgm8tfn91kjdx6l",
10 "taskName": "dtsmmcgm8tfn91kjdx6l",
11 "status": "running",
12 "dataType": [
13 "base",
14 "increment"
15 ],
16 "region": "bd",
17 "createTime": "2022-11-24T03:45:52Z",
18 "srcConnection": {
19 "dbServer": "",
20 "instanceType": "bcegateway",
21 "region": "bd",
22 "dbType": "redis",
23 "dbHost": "100.80.143.80",
24 "dbPort": 28,
25 "dbUser": "",
26 "dbPass": "",
27 "instanceId": "",
28 "subnetShortId": "sbn-ka9xp8yuj81n",
29 "vpcId": "1cd2dd00-b2c8-4053-9550-594a2991cc6e",
30 "vpcShortId": "vpc-2a0giawvdben",
31 "zone": "cn-bd-c"
32 },
33 "dstConnection": {
34 "dbServer": "",
35 "instanceType": "public",
36 "region": "bj",
37 "dbType": "redis",
38 "dbHost": "10.156.64.44",
39 "dbPort": 7020,
40 "dbUser": "",
41 "dbPass": "",
42 "instanceId": ""
43 },
44 "schemaMapping": null,
45 "granularity": null,
46 "subStatus": [
47 {
48 "b": "running",
49 "i": "queue"
50 }
51 ],
52 "dynamicInfo": {
53 "base": [],
54 "increment": null
55 },
56 "statistic": null,
57 "errmsg": null,
58 "sdkRealtimeProgress": ""
59 "subDataScope": {
60 "startTime": "",
61 "endTime": ""
62 }
63 "lockStatus": "unlock",
64 "expireTime": "-1",
65 "checksumResult": "CONSISTENT"
66 }
67 ]
68}