查询任务列表

更新时间：2025-02-20

接口说明

查看所有数据传输任务列表

请求结构

                JSON
                
            

                POST /v{version}/task/list
Host: dts.baidubce.com    
Authorization: authorization string

{
  "maxKeys" : 15,
  "marker" : "1",
  "type" : "migration"
}
            

请求参数

参数名称	参数类型	是否必须	描述	示例值	参数位置
version	String	是	API版本号	"1"	URL参数
type	String	是	任务类型	单向任务："migration"、双向同步任务："bidirect"、任务组："group"、一键反向："rollback"；传空时返回所有类型任务	Request Body 参数
marker	String	否	分页参数，初次请求无需设置，后续请求使用上次响应中的nextMarker	1	Request Body 参数
maxKeys	Integer	否	分页参数，每页数据条数，默认为 10	15	Request Body 参数

响应头参数

除公共头域，无其它特殊头域。

响应体参数

响应体字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
task	List<Task>	是	任务数组	task
nextMarker	String	是	分页参数，下一页标记	dtsmxxxyyy
maxKeys	Integer	是	分页参数，数据条数最大值	10
truncated	Boolean	是	是否截断	false

Task字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
dtsId	String	是	任务ID	dtsmxxyy1234
taskName	String	是	任务名称	dtsmxxyy1234
status	String	是	任务状态 unConfig：未配置, 当用户创建完任务后, 就进入未配置状态, 该状态只有dtsId信息 ready：未启动, 当配置完后任务后就进入未启动状态, 这时就包含任务的所有信息 checking：前置检查中, 当用户点击启动后, 先会进行前置检查 checkPass：前置检查通过, 只有前置检查通过后, 才可以进行启动任务 checkFailed：前置检查失败, 任务启动时,会进行前置检查, 若检查失败, 就进入该状态, 这时可以进行修改任务或直接结束任务 running：运行中，前置检测通过后, 就进入该状态, 包括数据迁移中或数据同步中 stopping：暂停中，处于该状态的任务不能进行任何操作 stopped：已暂停，从该状态启动，会进行断点续传，比如：暂停后修改数据同步对象 stopCheckFailed：已暂停(新增同步对象前置检查失败)，当新增同步对象时,会进行前置检查,如果检查失败,回到已暂停状态,但是可以查看检查失败原因 runFailed：运行失败, 当运行过程中出现异常就进入该状态，如果是可恢复错误, 修复后可继续启动，如果是不可恢复错误, 只能结束任务 finished：任务结束，包括手工进行结束，或任务完成后自动结束，或出现不可恢复的错误	finished
dataType	String[]	是	传输数据类型数组（schema：结构迁移；base：全量迁移；increment：增量迁移）	["base", "increment"]
region	String	是	地域	bj
createTime	String	是	创建时间	2020-12-10T13: 24: 10Z
srcConnection	Connection	是	srcConnection	srcConnection
dstConnection	Connection	是	dstConnection	dstConnection
schemaMapping	SchemaMapping	是	schemaMapping	schemaMapping
runningTime	Integer	是	任务已运行时长	20
subStatus	List<SubStatus>	是	子任务状态
dynamicInfo	DynamicInfo	是	dynamicInfo	dynamicInfo
errmsg	String	是	执行失败时返回的错误信息, 执行成功时为空字符串	errmsg
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）	readSpeed
checksumResult	ChecksumResult	是	校验结果，可能值：CONSISTENT（一致），INCONSISTENT（不一致），NONE（未知，校验任务运行未结束）	CONSISTENT
dtsIdPos	String	是	双向同步任务时，正向任务ID	dtsmxxyy1234
dtsIdNeg	String	是	双向同步任务时，反向任务ID	dtsmxxyy1234
dtsTaskPos	DtsTaskPos	是	双向同步任务时，正向任务信息	dtsTaskPos
dtsTaskNeg	DtsTaskNeg	是	双向同步任务时，反向任务信息	dtsTaskNeg
dtsTasks	DtsTasks[]	是	任务组任务时，子任务信息	dtsTasks
bindTags	List<BindTags>	否	绑定标签	BindTags

Connection字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
instanceType	String	否	实例类型	bcerds
region	String	否	地域	bj
dbType	String	否	数据库类型	mysql
dbUser	String	否	数据库访问账号	dts_trans
dbPass	String	否	数据库访问密码	dbPass
dbPort	Integer	否	数据库访问端口	3306
dbHost	String	否	数据库ip或主机名	192.168.1.1
instanceId	String	否	实例ID	rdsmfgdti3d53f5
field_whitelist	String	否	列过滤（白名单）	field_whitelist
field_blacklist	String	否	列过滤（黑名单）	field_blacklist
supportOnlineDDL	String	否	同步Online DDL	true，false
maxRetryTime	String	否	重试时间	720
sqlType	String	否	同步语句选择	I,U,D,Q

Schema字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
type	String	否	需要传输的对象类型, 取值有: db(库), table(表), view(视图), function(函数), procedure(存储过程)	table
src	String	否	源库的schema名称	test.table_src
dst	String	否	目标库的schema名称	test.table_dst
where	String	否	where过滤条件	where

SubStatus字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
s	String	是	结构	running
b	String	是	全量	running
i	String	是	增量	running

DynamicInfo字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
schema	List<DynamicInfoSchema>	是	DynamicInfoSchema	DynamicInfoSchema
base	List<DynamicInfoBase>	是	DynamicInfoBase	DynamicInfoBase
increment	List<DynamicInfoIncrement>	是	DynamicInfoIncrement	DynamicInfoIncrement

DynamicInfoSchema字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
current	String	是	已迁移schema数	800
count	String	是	迁移总schema数	1000
speed	String	是	迁移速度	500
expectFinishTime	String	是	预测剩余时间(s)	20

DynamicInfoBase字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
current	String	是	已迁移数据行数	800
count	String	是	迁移总数据行数	1000
speed	String	是	迁移速度	500
expectFinishTime	String	是	预测剩余时间(s)	20

DynamicInfoIncrement字段数据结构说明

参数名称	参数类型	描述	示例值
delay	String	增量同步延迟（单位秒） "-1": 代表未知	-1、0、13、102等
position	String	同步位点	mysql的格式例如mysql-bin.000000:123456
syncStatus	String	同步任务状态	"正常" 或 "异常"

SubDataScope字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
startTime	String	是	开始时间	startTime
endTime	String	是	结束时间	endTime

AccountMapping字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
user	String	否	用户	dts_user
hosts	String[]	否	地址	["%", "1.2.3.4", "10.10.10.1"]

InitPosition字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
type	String	否	默认值offset	offset
position	String	否	填写redis实例replication backlog中有效有效的offset值，格式为:"9654766427"。若不填写则标识做全量+增量迁移

PayInfo字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
productType	String	是	付费方式，预付费（prepay）、后付费（postpay）	postpay
sourceInstanceType	String	是	源端实例类型（OnBce：百度智能云数据库；OffBce：自建数据存储）	OnBce
targetInstanceType	String	是	目标端实例类型（OnBce：百度智能云数据库；OffBce：自建数据存储）	OnBce
crossRegionTag	Integer	是	跨地域标识（0：同地域；1：跨地域）	0
createTime	Long	是	资源创建时间，UNIX 时间戳（毫秒数）	1607606657000
standard	String	是	规格（Large：大规格；目前仅支持大规格）	Large
endTime	Long	是	UNIX 时间戳（毫秒数）	1607606657000

DtsTaskPos字段数据结构说明

dtsTaskPos 字段，即双向同步任务时，正向任务信息，所以该字段的值结构跟任务本身结构一致。

DtsTaskNeg字段数据结构说明

dtsTaskNeg 字段，即双向同步任务时，反向任务信息，所以该字段的值结构跟任务本身结构一致。

DtsTasks字段数据结构说明

dtsTasks 字段，即任务组任务时，子任务信息，所以该字段的值结构跟任务本身结构一致。

BindTags字段数据结构说明

参数名称	参数类型	是否必须	描述	示例值
tagKey	String	是	标签 key	默认项目
tagValue	String	是	标签 value	dtsTask1

请求示例

                JSON
                
            

                POST /v1/task/list

Host: dts.baidubce.com    
ContentType: application/json     
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
{
  "maxKeys" : 15,
  "marker" : "1",
  "type" : "migration"
}
            

响应示例

                JSON
                
            

                HTTP/1.1 200 OK

{
  "nextMarker" : "dtsmxxxyyy",
  "task" : [ {
    "subDataScope" : {
      "startTime" : "startTime",
      "endTime" : "endTime"
    },
    "schemaMapping" : [ {
      "dst" : "test.table_dst",
      "src" : "test.table_src",
      "where" : "where",
      "type" : "table"
    }, {
      "dst" : "test.table_dst",
      "src" : "test.table_src",
      "where" : "where",
      "type" : "table"
    } ],
    "dataType" : [ "schema", "base" ],
    "dtsId" : "dtsmxxyy1234",
    "errmsg" : "errmsg",
    "runningTime" : 20,
    "dtsIdNeg" : "dtsmxxyy1234",
    "subStatus" : [ {
      "b" : "running",
      "s" : "running",
      "i" : "running"
    }, {
      "b" : "running",
      "s" : "running",
      "i" : "running"
    } ],
    "dtsIdPos" : "dtsmxxyy1234",
    "sdkRealtimeProgress" : "sdkRealtimeProgress",
    "lockStatus" : "unlock",
    "createTime" : "2020-12-10T13: 24: 10Z",
    "granularity" : "dbtb",
    "dtsTaskNeg" : { },
    "taskName" : "dtsmxxyy1234",
    "region" : "bj",
    "srcConnection" : {
      "dbPass" : "dbPass",
      "dbPort" : 3306,
      "instanceId" : "rdsmfgdti3d53f5",
      "instanceType" : "bcerds",
      "dbUser" : "_dts_trans_",
      "field_whitelist" : "field_whitelist",
      "dbType" : "mysql",
      "dbHost" : "192.168.1.1",
      "field_blacklist" : "field_blacklist",
      "region" : "bj"
    },
    "dynamicInfo" : {
      "schema" : [ {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      }, {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      } ],
      "increment" : [ [ { }, { } ], [ { }, { } ] ],
      "base" : [ {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      }, {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      } ]
    },
    "payInfo" : {
      "standard" : "Large",
      "sourceInstanceType" : "OnBce",
      "createTime" : 1607606657000,
      "targetInstanceType" : "OnBce",
      "crossRegionTag" : 0,
      "endTime" : 1607606657000,
      "productType" : "postpay"
    },
    "dtsTaskPos" : { },
    "status" : "finished"
  }, {
    "subDataScope" : {
      "startTime" : "startTime",
      "endTime" : "endTime"
    },
    "schemaMapping" : [ {
      "dst" : "test.table_dst",
      "src" : "test.table_src",
      "where" : "where",
      "type" : "table"
    }, {
      "dst" : "test.table_dst",
      "src" : "test.table_src",
      "where" : "where",
      "type" : "table"
    } ],
    "dataType" : [ "base", "base" ],
    "dtsId" : "dtsmxxyy1234",
    "errmsg" : "errmsg",
    "runningTime" : 20,
    "dtsIdNeg" : "dtsmxxyy1234",
    "subStatus" : [ {
      "b" : "running",
      "s" : "running",
      "i" : "running"
    }, {
      "b" : "running",
      "s" : "running",
      "i" : "running"
    } ],
    "dtsIdPos" : "dtsmxxyy1234",
    "sdkRealtimeProgress" : "sdkRealtimeProgress",
    "lockStatus" : "unlock",
    "createTime" : "2020-12-10T13: 24: 10Z",
    "granularity" : "dbtb",
    "dtsTaskNeg" : { },
    "taskName" : "dtsmxxyy1234",
    "region" : "bj",
    "srcConnection" : {
      "dbPass" : "dbPass",
      "dbPort" : 3306,
      "instanceId" : "rdsmfgdti3d53f5",
      "instanceType" : "bcerds",
      "dbUser" : "_dts_trans_",
      "field_whitelist" : "field_whitelist",
      "dbType" : "mysql",
      "dbHost" : "192.168.1.1",
      "field_blacklist" : "field_blacklist",
      "region" : "bj"
    },
    "dynamicInfo" : {
      "schema" : [ {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      }, {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      } ],
      "increment" : [ [ { }, { } ], [ { }, { } ] ],
      "base" : [ {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      }, {
        "expectFinishTime" : "20",
        "current" : "800",
        "count" : "1000",
        "speed" : "500"
      } ]
    },
    "payInfo" : {
      "standard" : "Large",
      "sourceInstanceType" : "OnBce",
      "createTime" : 1607606657000,
      "targetInstanceType" : "OnBce",
      "crossRegionTag" : 0,
      "endTime" : 1607606657000,
      "productType" : "postpay"
    },
    "dtsTaskPos" : { },
    "dtsTasks" : [{}],
    "statistic": {
        "readSpeed": "",
        "writeSpeed": ""
    },
    "initPosition": {
        "type": "",
        "position": ""
    },
    "status" : "finished"
  } ],
  "maxKeys" : 10,
  "truncated" : false,
  "bindTags": [{"tagKey": "默认项目", "tagValue": "dtstest"}]
}
            

查询任务信息

配置任务

百度智能云

数据传输服务 DTS

数据传输服务 DTS

查询任务列表

接口说明

请求结构

请求参数

响应头参数

响应体参数

响应体字段数据结构说明

Task字段数据结构说明

Connection字段数据结构说明

Schema字段数据结构说明

SubStatus字段数据结构说明

DynamicInfo字段数据结构说明

DynamicInfoSchema字段数据结构说明

DynamicInfoBase字段数据结构说明

DynamicInfoIncrement字段数据结构说明

SubDataScope字段数据结构说明

AccountMapping字段数据结构说明

InitPosition字段数据结构说明

PayInfo字段数据结构说明

DtsTaskPos字段数据结构说明

DtsTaskNeg字段数据结构说明

DtsTasks字段数据结构说明

BindTags字段数据结构说明

请求示例

响应示例