接口功能介绍

查询 DTS 任务列表。

接口约束

无

URI

POST /dts/v2/open-api/instance/describeDtsJobs

路径参数 无

Query参数 无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池id	200000001790

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
pageSize	否	Integer	条数	20
pageNumber	否	Integer	当前页码	1
dtsInstanceId	否	String	dts实例id	dts-ins-2026001
dtsJobId	否	Integer	dts任务id	123456789001
dtsJobName	否	String	dts任务名称	MySQL_to_Kafka同步任务
statusList	否	Array of Strings	状态：UNCONFIGURED (未配置),RUNNING (运行中),RETRYING (重试中),UPDATE_SUB_JOB (修改同步对象中),UNPRECHECK (未预检查),PRECHECKING (预检查中),PRECHECKFAILURE (未通过预检查),PRECHECKPASS (预检查通过),MIGRATING (结构迁移中),MIGRATED (结构迁移完成),START ((全量) 开始),FULLOVER (全量迁移完成),INCSTART ((增量) 开始),STOP (暂停 (可再次启动)),PAUSE (运行异常 (可再次启动)),REVERSE (一键切换),FINISH (完成 (终结)),INC_SERVICE_START (源端读取服务开始),INC_SERVICE_DISPATCH_DONE (源端读取服务运行中),POST_STRUCT_START (后置结构迁移开始),POST_STRUCT_DONE (后置结构迁移完成),INC_DISPATCH_START (增量服务调度开始),INC_DISPATCH_DONE (增量服务调度完成，增量运行中),MONITOR_START (监控开始),MONITOR_DISPATCH_DONE (监控调度完成),FAILOVER_SWITCHING (udal 的容灾切换)	["RUNNING","FINISH"]
prodManagerOrServiceIp	否	String	管理IP或者业务IP	192.168.10.15
tagConfigRelModelList	否	Array of Objects	标签配置		TagObjectRelModel
groupId	否	Integer	分布式任务的父任务id	987654321
jobType	否	String	任务类型，枚举值：MIGRATE, SYNC, REPLICATION, SUBSCRIBE, SUB_TASK...	SYNC
sourceEngineType	否	String	源端db类型，枚举值：MYSQL, ALISQL, ORACLE, UDAL, KAFKA...	MYSQL
destinationEngineType	否	String	目标端db类型，枚举值：MYSQL, ALISQL, ORACLE, UDAL, KAFKA...	KAFKA

表 TagObjectRelModel

参数	是否必填	参数类型	说明	示例
tagKey	否	String	标签键	env
tagValue	否	String	标签值	prod
labelId	否	String	标签id	label_10001
resourceId	否	String	资源id	dts_job_2026001
resourceType	否	String	资源类型	DTS_JOB

响应参数

参数	参数类型	说明	下级对象
httpStatusCode	Integer	状态码
errCode	String	错误码
errMessage	String	提示信息
success	Boolean	请求是否成功
requestId	String	请求id
data	Array of Objects	响应数据	DtsJobVo
pageNumber	Integer	页码
pageRecordCount	Integer	当前页可展示的最大记录数
totalRecordCount	Integer	记录总数

表 DtsJobVo

参数	参数类型	说明	示例	下级对象
dtsJobName	String	任务名称
dtsInstanceId	String	实例id
dtsInstanceName	String	实例名称
dtsJobId	Integer	任务id
projectId	String	项目id
projectName	String	项目名称
jobType	String	任务类型，枚举值：MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODB
jobDirection	String	任务方向，枚举值：Forward, Reverse
instanceStatus	String	实例状态，枚举值：DEPLOYING (开通中),RUNNING (可使用),FROZEN (已冻结),RENEWING (续订中),REFUNDING (退订中),CANCELING (注销中),RELEASED (已注销)
jobStatus	String	任务状态，枚举值：UNCONFIGURED (未配置),RUNNING (运行中),RETRYING (重试中),UPDATE_SUB_JOB (修改同步对象中),UNPRECHECK (未预检查),PRECHECKING (预检查中),PRECHECKFAILURE (未通过预检查),PRECHECKPASS (预检查通过),MIGRATING (结构迁移中),MIGRATED (结构迁移完成),START ((全量) 开始),FULLOVER (全量迁移完成),INCSTART ((增量) 开始),STOP (暂停 (可再次启动)),PAUSE (运行异常 (可再次启动)),REVERSE (一键切换),FINISH (完成 (终结)),INC_SERVICE_START (源端读取服务开始),INC_SERVICE_DISPATCH_DONE (源端读取服务运行中),POST_STRUCT_START (后置结构迁移开始),POST_STRUCT_DONE (后置结构迁移完成),INC_DISPATCH_START (增量服务调度开始),INC_DISPATCH_DONE (增量服务调度完成，增量运行中),MONITOR_START (监控开始),MONITOR_DISPATCH_DONE (监控调度完成),FAILOVER_SWITCHING (udal 的容灾切换)
payType	String	实例付费类型，枚举值：PRE_PAY, POST_PAY
jobClass	String	实例规格大小
instanceCreateTime	String	实例创建时间
jobCreateTime	String	任务创建时间
jobFinishTime	String	任务完成时间
expireTime	String	实例过期时间
migrationMode	Object	迁移模式		MigrationMode
dataInitialization	Object	全量模块信息		ModuleProgressInfo
dataSynchronization	Object	增量模块信息		ModuleProgressInfo
dataCheckInfo	Object	数据校验模块信息		ModuleProgressInfo
precheck	Object	预检查模块信息		ModuleProgressInfo
structureInitialization	Object	结构迁移模块信息		ModuleProgressInfo
dbList	String	同步对象
machineList	Array of Objects	同步机器列表		MachineBaseInfoVO
tagList	Array of Objects	标签列表		TagObjectRelModel
sourceDbEndpoint	Object	源端连接信息		DbEndpointVo
destinationEndpoint	Object	目标端连接信息		DbEndpointVo
retryStateInfo	Object	重试状态信息		RetryStateInfo
reverseJob	String	反向任务，数据类型：DtsJobVo	{}
extraProperties	Object	扩展属性		ExtraPropertiesInfo
errorInfo	Array of Objects	错误信息		ErrorInfo
subJobOperationType	String	子任务操作类型，枚举值：ADD, REMOVE, INIT

表 MigrationMode

参数	参数类型	说明
dataInitialization	Boolean	是否迁移全量数据
dataSynchronization	Boolean	是否迁移增量数据
structureInitialization	Boolean	是否执行结构迁移

表 ModuleProgressInfo

参数	参数类型	说明
status	String	模块状态，枚举值：NIT (初始态),STARTING (启动中),RUNNING (运行中),FAIL (失败),STOP (暂停),RETRY (重试中),DONE (完成)
progress	String	模块整体进度
performance	String	每秒增量同步或迁移至目标表的数据行数和数据量
errorMessage	String	模块失败的错误提示
delay	Integer	增量数据迁移的延迟，单位为毫秒

表 MachineBaseInfoVO

参数	参数类型	说明
host	String	管理Ip
vpcIp	String	vpcIp
vpcId	String	vpcId
vpcName	String	vpc名称
vpcIpv6	String	vpcIpv6
ipv6BindId	String	ipv6绑定id
eip	String	弹性公网ip
hostCode	String	主机id
subnetId	String	实例所在子网id
subnetName	String	实例所在子网名称
securityGroupId	String	安全组id
securityGroupName	String	安全组名称

表 DbEndpointVo

参数	参数类型	说明
endpointType	String	实例类型，枚举值：EIP, RDS, ECS, VPN, VPC
instanceId	String	实例id
engineName	String	数据库类型，枚举值：MYSQL, ORACLE, UDAL, KAFKA, TIDB, SQLSERVER, POSTGRESQL, CLICKHOUSE, DORIS, TELEDBX, MONGODB
region	String	实例所属区域
ip	String	实例的连接地址
port	Integer	数据库服务端口
databaseName	String	迁移对象所属数据库的名称
userName	String	数据库账号
password	String	数据库密码
oracleSid	String	oracle 数据库sid信息
mongoDBSchemaType	String	mongoDb架构类型，枚举值：SINGLE, REPLICASET, SHARDING
sslSolutionEnum	String	SSL安全连接配置，枚举值：DISABLE, ENABLE_WITH_CERTIFICATE, ENABLE_ONLY_KAFKA_SCRAM_SHA_256
accessMode	String	rds数据库的读写模式

表 RetryStateInfo

参数	参数类型	说明	示例
planModuleId	Integer	模块任务id
moduleType	String	模块类型，枚举值：PRECHECK (预检查),STRUCT (前置结构迁移),POST_STRUCT (后置结构迁移),FULL (全量迁移),READER (增量读取),WRITER (增量写入),STORE (增量存储),INC_SERVICE (增量服务),MONITOR (监控上报),DATA_CHECK (数据稽查)	STRUCT
maxRetryTime	Integer	最大重试时间，单位为秒
retryCount	Integer	已经重试次数
retryTime	Integer	已经重试时间，单位为秒
migrationErrorMsg	String	迁移错误信息
migrationErrorCode	String	迁移错误码

表 ErrorInfo

参数	参数类型	说明	示例
errorCode	String	错误码
errorMessage	String	错误信息
errorTime	String	错误时间
module	String	所属模块，枚举值：RECHECK (预检查),STRUCT (前置结构迁移),POST_STRUCT (后置结构迁移),FULL (全量迁移),READER (增量读取),WRITER (增量写入),STORE (增量存储),INC_SERVICE (增量服务),MONITOR (监控上报),DATA_CHECK (数据稽查)	STRUCT

表 ExtraPropertiesInfo

参数	参数类型	说明	示例	下级对象
forwardOrReverseId	Integer	正向或反向任务id	1001
conflictStrategy	String	枚举值：IGNORE, OVERWRITE, TASKFAILED, REPLACE	IGNORE
bilateralSync	Boolean	是否是双向任务	false
ddlSync	Boolean	是否同步DDL	true
lowerCase	String	目标端是否转小写: DEFAULT, LOWER, UPPER, ORIGIN，枚举值：DEFAULT, LOWER, UPPER, ORIGIN	DEFAULT
forwardConflictStrategy	String	正向冲突策略： IGNORE, OVERWRITE, TASKFAILED, REPLACE，枚举值：IGNORE, OVERWRITE, TASKFAILED, REPLACE	OVERWRITE
reveresConflictStrategy	String	反向冲突策略： IGNORE, OVERWRITE, TASKFAILED, REPLACE，枚举值：IGNORE, OVERWRITE, TASKFAILED, REPLACE	OVERWRITE
pgPluginName	String	增量同步时，pg使用的逻辑解码插件名称	pgoutput
migrateUser	Boolean	是否迁移用户	false
projectId	String	企业项目id	proj_001
projectName	String	企业项目名称	测试项目
backup	Boolean	是否为UDAL容灾任务	false
backupType	String	UDAL容灾任务类型，枚举值：PARTITION_LOGICAL_REPLICATION, PARTITION_RAW_REPLICATION, GLOBAL_BINLOG_LOGICAL_REPLICATION, GLOBAL_BINLOG_RAW_REPLICATION, LOGICAL_REPLICATION...	LOGICAL_REPLICATION
backupInformation	Object	容灾信息		BackupInformation
zkSync	Boolean	UDAL容灾：是否同步zk	false
configSync	Boolean	UDAL容灾：是否同步配置库	false
configBio	Boolean	UDAL容灾：配置库是否双向	false
sourceOrTarget	String	是否使用目标部署zkcdc	target
userId	String	用户id	user_123
circleTableName	String	防循环表名,以这个优先	circle_table
rateLimiter	Object	限速配置		RateLimiterInfo
mongoDBSource	Object	mongo源库配置		MongoDBInformation
mongoDBTarget	Object	mongo目标库配置		MongoDBInformation
mongoDBExtraProperties	Object	mongo附加属性		MongoDBExtraProperties
udalSource	Object	udal源库配置		UdalInformation
udalTarget	Object	udal目标库配置		UdalInformation
binlogPosition	Object	binlog位点		BinlogPosition
reverseDataSync	Boolean	枚举值：无	false
zkcdcTaskId	String	zkcdc任务id	zk_task_001
subTaskType	String	子任务类型	sync
sourceUdalRdsSetName	String	sourceUdalRdsSetName	udal_set_01
targetUdalRdsSetName	String	targetUdalRdsSetName	udal_set_02
sourceBackupNode	Object	sourceBackupNode		SourceBackupNode
zkTask	Boolean	是否是容灾zk同步任务	false
configDataBaseTask	Boolean	是否是容灾配置库同步任务	false
destinationKafkaExtraProperties	Object	destinationKafkaExtraProperties		KafkaExtraProperties
destinationDorisExtraProperties	Object	destinationDorisExtraProperties		DorisExtraProperties
destinationClickHouseExtraProperties	Object	destinationClickHouseExtraProperties		ClickHouseExtraProperties
sourceTiDBIncExtraProperties	Object	sourceTiDBIncExtraProperties		TiDBIncExtraProperties
sourceDbSid	String	源端为oracle时，数据库sid	ORCL
targetDbSid	String	目标端为oracle时，数据库sid	ORCL
choseNodeIds	Array of Integers	部署任务时，用户选择的某个实例下的节点id列表	[1,2,3]
srcInstanceName	String	源端实例名称	mysql_source
targetInstanceName	String	目标端实例名称	mysql_target
isCountCheck	Boolean	是否行级稽查	false
checkerRatio	Integer	内容稽查任务的抽样率	100
maxDiffCount	Integer	不一致行数超过的表不再比较剩余数据	1000
maxRecheckTime	Integer	内容稽查任务对不一致数据的复检次数	3
quickCheck	Boolean	快速对比只对比常见的数据类型	false
correctData	Boolean	内容稽查任务是否自动修正不一致数据	false
multiToOne	Boolean	多到一的数据源映射下，内容稽查只比较源端存在的数据，不比较目标端多余的数据	false
transformConfig	String	ETL Transformer配置	{}
subJobOperationType	String	枚举值：ADD, REMOVE, INIT	ADD
sourceUseSSL	Boolean	枚举值：无	false
sourceCertUrl	String	sourceCertUrl	/cert/source.crt
targetUseSSL	Boolean	枚举值：无	false
targetCertUrl	String	targetCertUrl	/cert/target.crt
filterByCircleTable	Boolean	是否采用回环表方式过滤反向数据	false
threadIdToFilter	Integer	针对rds并且采用threadId方式过滤回环数据时，过滤该线程id的回环数据	12345

表 BackupInformation

参数	参数类型	说明	示例	下级对象
sourceUserId	Integer	sourceUserId
targetUserId	Integer	targetUserId
setRelation	String	setRelation
backupZkInformation	Object	UDAL容灾任务需要的zk配置信息		BackupZkInformation
configMetaInformation	Array of Objects	UDAL容灾任务需要的配置库信息		UdalConfigDatasource
configMetaDatabaseMap	Array of Strings	UDAL容灾任务需要的配置库映射信息	-
dataHostMap	Map of String	UDAL容灾任务需要的dataHost映射信息	-
rdsProdMap	Map of String	rdsProdMap
hostNameMap	Array of Objects	数组[0]是源,[1]是目标，key是分片的ip:port,value是hostName，在原生复制时需要		Map of String
dataHostMapList	Array of Objects	数据库域名映射		Map of String
ipToDatabasesMap	Map of String	数据库ip到数据库映射
wholeDatabases	Array of Strings	整库数据库列表
dataHostMapText	String	数据库ip到数据库映射文本
targetVersion	String	目标库版本
sourceVersion	String	源库版本
sourceUdalUrl	String	udal源库url
targetUdalUrl	String	udal目标库url
sourceRegionId	String	源库资源池id
targetRegionId	String	目标库资源池id
sourceTenantId	String	源库租户id
sourceClusterId	String	源库集群id
targetClusterId	String	目标库集群id
zkcdcTaskId	String	zkcdc任务id
offsetForRecovery	String	恢复offset
targetTenantId	String	目标库租户id

表 BackupZkInformation

参数	参数类型	说明	示例	下级对象
sourceZkUrl	String	sourceZkUrl	127.0.0.1:2181
sourceZkNamespace	String	sourceZkNamespace	/udal/src
targetZkUrl	String	targetZkUrl	127.0.0.2:2181
targetZkNamespace	String	targetZkNamespace	/udal/dst
zkCdcTaskId	String	zkCdcTaskId	zkcdc_10001
status	String	status	RUNNING
dbproxyNodeId	String	dbproxyNodeId	dbp_001
sourceZookeeperId	String	sourceZookeeperId	zk_src_01
sourceUdalZkDetails	Array of Objects	sourceUdalZkDetails		UdalZkDetails
sourceSecondaryNamespace	String	sourceSecondaryNamespace	/udal/src/sec
targetSecondaryNamespace	String	targetSecondaryNamespace	/udal/dst/sec
targetZookeeperId	String	targetZookeeperId	zk_dst_01
targetUdalZkDetails	Array of Objects	targetUdalZkDetails		UdalZkDetails

表 UdalZkDetails

参数	参数类型	说明	示例
id	String	id	node_001
zkId	String	zkId	zk_ins_01
host	String	host	10.12.34.56
clientPort	String	clientPort	2181
peerPort	String	peerPort	2888
electPort	String	electPort	3888
zkServerId	String	zkServerId	server.1
sshPort	String	sshPort	22
sshUser	String	sshUser	zkadmin
sshPassword	String	sshPassword	Zk@123456
deployPath	String	deployPath	/usr/local/zookeeper
createTime	String	createTime	2025-05-10 14:20:10
updateTime	String	updateTime	2025-05-12 09:15:33

表 UdalConfigDatasource

参数	参数类型	说明	示例
ip	String	ip	192.168.10.12
port	String	port	3306
url	String	url	jdbc:mysql://192.168.10.12:3306
username	String	username	root
password	String	password	Udal@Pass123

表 RateLimiterInfo

参数	参数类型	说明	示例
fullRps	Integer	全量迁移每秒限制迁移多少行	10000
fullBps	Integer	全量迁移每秒限制迁移多少字节	52428800
incRps	Integer	增量迁移每秒限制迁移多少行	20000
incBps	Integer	增量迁移每秒限制迁移多少字节	104857600
rateLimiterEnable	Boolean	是否开启全量限流	true
incRateLimiterEnable	Boolean	是否开启增量限流	false

表 MongoDBInformation

参数	参数类型	说明	示例	下级对象
mongoDBNodeList	Array of Objects	mongoDBNodeList		MongoDBNode
userNameShard	String	userNameShard	admin
passwordShard	String	passwordShard	Admin@123
shardUrlList	Array of Strings	shardUrlList	["mongodb://192.168.1.10:27017","mongodb://192.168.1.11:27017"]
dbUrl	String	dbUrl	mongodb://192.168.1.10:27017,192.168.1.11:27017/admin
directConnection	Boolean	是否直连副本集单一节点	false
mongoDBSchemaType	String	mongoDb 的架构类型：SINGLE, REPLICASET, SHARDING，枚举值：SINGLE, REPLICASET, SHARDING	REPLICASET
authDbName	String	MongoDB的鉴权数据库	admin
replicaSetName	String	副本集名称	rs0

表 MongoDBNode

参数	参数类型	说明	示例
ip	String	ip	192.168.1.10
writePort	Integer	writePort	27017
readPort	Integer	readPort	27017
nodeType	String	nodeType	PRIMARY
hostType	String	hostType	SHARD

表 MongoDBExtraProperties

参数	参数类型	说明	示例
migTag	Boolean	是否迁移shardTag	false
captureMode	String	增量获取方式 OPLOG, CHANGESTREAM, AGGREGATION_OPLOG，枚举值：OPLOG, CHANGESTREAM, AGGREGATION_OPLOG	OPLOG
userDefinedTimestamp	String	自定义启动时间	1735689600000

表 UdalInformation

参数	参数类型	说明	示例	下级对象
shardDbInfo	Array of Objects	shardDbInfo		ShardDbInfo
useSsl	Boolean	useSsl	false
certUrl	String	certUrl	/cert/udal_client.crt
isPrimary	Boolean	isPrimary	true
shardDbSamePwd	Boolean	shardDbSamePwd	false
useMapIp	Boolean	useMapIp	true
principal	String	principal	udal@TEST.COM
clusterId	String	clusterId	udal_cluster_01
tenantId	String	tenantId	tenant_202501
userId	Integer	userId	1008611
sourceBackupNode	Object	sourceBackupNode		SourceBackupNode
udalRdsSetName	String	udalRdsSetName	udal_sz_set
groupId	String	groupId	group_0001
groupName	String	groupName	sz_biz_group
regionId	String	regionId	cn-shenzhen
zkUrl	String	zkUrl	127.0.0.1:2181
zkNamespace	String	zkNamespace	/udal/main
zookeeperId	String	zookeeperId	zk_001
udalZkDetails	Array of Objects	udalZkDetails		UdalZkDetails
secondaryNamespace	String	secondaryNamespace	/udal/secondary
endpointType	String	枚举值：EIP, RDS, ECS, VPN, VPC	RDS
endpointInstanceId	String	endpointInstanceId	rm-bp1xxxxxx
endpointEngine	String	枚举值：MYSQL, ALISQL, ORACLE, UDAL, KAFKA...	UDAL
endpointRegion	String	endpointRegion	cn-shenzhen
endpointIp	String	endpointIp	192.168.10.22
endpointPort	Integer	endpointPort	3306
endpointDatabase	String	endpointDatabase	udal_meta
endpointUserName	String	endpointUserName	root
endpointPassword	String	endpointPassword	Udal@Pass123
configDatabase	String	configDatabase	config_db
version	String	version	3.1.2
udalConsoleUrl	String	udalConsoleUrl	http://udal-sz.xxx.com
dbproxyNodeId	String	dbproxyNodeId	dbproxy_001

表 BinlogPosition

参数	参数类型	说明	示例
file	String	binlog文件名	mysql-bin.000001
pos	Integer	binlog位点数值	156
gtids	String	gtid事务位点信息	41f77f98-xxxx:1-100

表 ShardDbInfo

参数	参数类型	说明	示例	下级对象
id	Integer	id	10001
shardDbUrl	String	shardDbUrl	jdbc:mysql://192.168.1.10:3306
shardMapDbUrl	String	shardMapDbUrl	jdbc:mysql://192.168.1.11:3306
agentMapDbUrl	String	agentMapDbUrl	jdbc:mysql://192.168.1.12:3306
shardDbUser	String	shardDbUser	root
shardDbPwd	String	shardDbPwd	Shard@123456
sourceBackupNode	Object	sourceBackupNode		SourceBackupNode

表 SourceBackupNode

参数	参数类型	说明	示例
sourceSshHost	String	sourceSshHost	10.0.0.100
sourceSshPort	String	sourceSshPort	22
sourceSshUser	String	sourceSshUser	admin
sourceSshPassword	String	sourceSshPassword	Ssh@Admin123
defaultsFile	String	defaultsFile	/etc/my.cnf

表 KafkaExtraProperties

参数	参数类型	说明	示例
topicName	String	topicPolicy为FOCUS时必填，数据统一投递到该topic	dts_data_sync
topicPolicy	String	FOCUS：统一投递到指定的topic；AUTO：根据库或者表分别投递到不同的topic	FOCUS
dataFormat	String	kafka消息格式：json、arvo	json
partitionPolicy	String	分区投递策略	TABLE_HASH
replicas	String	topic的副本数量	2
partitions	String	topic的分区数量	6
securityProtocol	String	安全协议：SASL_PLAINTEXT、PLAINTEXT	PLAINTEXT
saslMechanism	String	使用SASL_PLAINTEXT协议时必填，SASL认证机制：GSSAPI，PLAIN	PLAIN
krb5FileName	String	kerberos服务的配置文件，SASL_PLAINTEXT协议、GSSAPI认证机制下必填，文件在测试连接阶段已经上传到机器指定的目录下，这里只需提供上传文件时返回给前端的文件名	krb5.conf
keytabFileName	String	kafka client的keytab文件，SASL_PLAINTEXT协议、GSSAPI认证机制下必填，文件在测试连接阶段已经上传到机器指定的目录下，这里只需提供上传文件时返回给前端的文件名	kafka.client.keytab
principal	String	kafka集群的kerberos principal，SASL_PLAINTEXT协议、GSSAPI认证机制下必填	kafka@EXAMPLE.COM
saslKerberosServiceName	String	kafka集群的kerberos服务名称，SASL_PLAINTEXT协议、GSSAPI认证机制下必填	kafka

表 DorisExtraProperties

参数	参数类型	说明	示例	下级对象
tableModel	String	doris表模型，有主键模型UNIQUE、明细模型DUPLICATE、聚合模型AGGREGATE	UNIQUE

表 ClickHouseExtraProperties

参数	参数类型	说明	示例	下级对象
tableEngine	String	clickhouse表引擎	MergeTree
clusterName	String	clickhouse集群名称	ck_cluster_01

表 TiDBIncExtraProperties

参数	参数类型	说明	示例
topicName	String	topicName	tidb_binlog_topic
securityProtocol	String	securityProtocol	PLAINTEXT
saslMechanism	String	saslMechanism	PLAIN
userName	String	userName	kafka_user
password	String	password	Kafka@123456
hostName	String	hostName	192.168.1.100
port	String	port	9092
principal	String	principal	tidb@EXAMPLE.COM
krb5FileName	String	krb5FileName	krb5_tidb.conf
keytabFileName	String	keytabFileName	tidb_client.keytab
saslKerberosServiceName	String	saslKerberosServiceName	kafka

枚举参数

无

请求示例

请求url

https://{host}/dts/v2/open-api/instance/describeDtsJobs

请求头header

无

请求体body

{
    "jobType": "SYNC",
    "pageNumber": 1,
    "pageSize": 10,
    "statusList": [
        "UNCONFIGURED",
        "CONFIGURING",
        "CONFIGUREDFAILURE",
        "UNPRECHECK",
        "PRECHECKING",
        "PRECHECKPASS",
        "PRECHECKFAILURE",
        "START",
        "INCSTART",
        "RUNNING",
        "RETRYING",
        "RESERVE",
        "MIGRATING",
        "FAILOVER_SWITCHING",
        "PAUSE",
        "RUNFAIL",
        "STOP",
        "MIGRATED",
        "FULLOVER",
        "FINISH",
        "DEPLOYING",
        "RENEWING",
        "REFUNDING",
        "CANCELING",
        "RELEASED"
    ],
    "dtsInstanceId": "89bfe543db844389a4d4ac969411ee08"
}

响应示例

{
    "httpStatusCode": 200,
    "success": true,
    "requestId": "00-6a16e1bd3d01275bbcdbb70b5a4f976d-1f91206f4983ec98-00",
    "data": [
        {
            "dtsJobName": "autotest-m2mdts20260527200939",
            "dtsInstanceId": "89bfe543db844389a4d4ac969411ee08",
            "dtsInstanceName": "autotest-m2mdts20260527200939",
            "dtsJobId": 383,
            "planConfigId": "383",
            "jobType": "SYNC",
            "jobDirection": "Forward",
            "instanceStatus": "RUNNING",
            "jobStatus": "UNCONFIGURED",
            "payType": "POST_PAY",
            "jobClass": "DTS_SYNC_SMALL",
            "instanceCreateTime": "2026-05-27T12:11:49.000+00:00",
            "jobCreateTime": "2026-05-27T12:20:58.000+00:00",
            "jobFinishTime": "2026-05-27T12:20:58.000+00:00",
            "expireTime": "2126-05-27T12:12:51.000+00:00",
            "migrationMode": {
                "dataInitialization": false,
                "dataSynchronization": false,
                "structureInitialization": false
            },
            "machineList": [
                {
                    "host": "33.2.6.184",
                    "vpcIp": "192.168.0.39",
                    "vpcId": "vpc-7y3gibha9l",
                    "vpcName": "vpc-xianlan-dds",
                    "vpcIpv6": "",
                    "eip": "",
                    "subnetId": "subnet-qi6u6apivg",
                    "subnetName": "subnet-b9d8",
                    "securityGroupId": "sg-igskpinsyg",
                    "securityGroupName": "Default-Security-Group"
                }
            ],
            "tagList": [],
            "sourceDbEndpoint": {
                "endpointType": "EIP",
                "engineName": "MYSQL",
                "sslSolutionEnum": "DISABLE"
            },
            "destinationEndpoint": {
                "endpointType": "EIP",
                "engineName": "MYSQL",
                "sslSolutionEnum": "DISABLE"
            },
            "extraProperties": {
                "bilateralSync": false,
                "ddlSync": false,
                "lowerCase": "ORIGIN",
                "forwardConflictStrategy": "REPLACE",
                "reveresConflictStrategy": "IGNORE",
                "pgPluginName": "pgoutput",
                "migrateUser": false,
                "backup": false,
                "zkSync": false,
                "configSync": false,
                "configBio": false,
                "sourceOrTarget": "target",
                "reverseDataSync": false,
                "zkTask": false,
                "configDataBaseTask": false,
                "isCountCheck": false,
                "checkerRatio": 100,
                "maxDiffCount": 200,
                "maxRecheckTime": 3,
                "quickCheck": false,
                "correctData": false,
                "multiToOne": false,
                "sourceUseSSL": false,
                "targetUseSSL": false,
                "filterByCircleTable": true,
                "threadIdToFilter": 0,
                "snapshotColumn": false
            },
            "errorInfo": []
        }
    ],
    "pageNumber": 1,
    "pageRecordCount": 1,
    "totalRecordCount": 1
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

数据传输服务DTS

数据传输服务DTS

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

数据传输服务DTS

数据传输服务DTS

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码