调用 DescribeTransmissionTaskProgress 接口查询传输任务进度。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
TaskId	String	否	4ddec6d036384248a25862fb17cb****	任务 ID。
ProgressType	String	否	Account	任务类型。取值如下： Account：表示用户迁移。在 TaskType 取值为 DataMigration 时，支持该取值。 Meta：表示结构迁移、库表结构订阅或结构初始化。 Full：表示全量迁移、全量订阅或全量初始化。 Incr：表示增量迁移、增量订阅或增量同步。 PostMeta：表示后置结构迁移。当 TaskType 取值为DataMigration 时，支持该取值。 MigrationAssessment：表示迁移评估。
PageNumber	Integer	否	1	页码。取值范围 1~1000，默认值为 1。
PageSize	Integer	否	10	每页记录数。取值范围 1~1000，默认值为 10。
TransmissionState	String	否	Transmitting	任务传输状态。取值如下： None：表示任务待启动。 Transmitting：表示任务传输中。 Completed：表示任务已完成。 Removed：表示任务传输失败。
ObjectType	String	否	Database	对象类型。取值如下： Database：表示数据库。 Table：表示表格。 View：表示视图。 Column：表示列。 Function：表示函数。 Procedure：表示程序。 Trigger：表示触发器。 Type：表示类型。 Domain：表示域名。 Sequence：表示序列。 Rule：表示规则。 Operator：表示操作符。 Aggregate：表示聚合。 Extension：表示扩展。 Constraint：表示约束。 PostSequence：表示 PostgreSQL 的序列。当参数为 PostgreSQL 时，需配置此参数。 Schema：表示模式。 Event：表示事件。 DomainConstraint：表示域约束。
Name	String	否	test***	对象名称。
LatencyDesc	Boolean	否	true	是否按照延迟降序排序。取值如下： true：表示按照降序排序。 false：表示不按照降序排序。
TransferEstimateRowsDesc	Boolean	否	false	是否按照传输预估传输行数降序排序。取值如下： true：表示按照降序排序。 false：表示不按照降序排序。

返回参数

参数	类型	示例值	描述
TaskProgress	Object of TaskProgress	{ "FullProgress":[ { "Database":{ "DestObjName":"test**1", "ObjectType":"Database", "SrcObjName":"test**1" }, "FinishTime":1679299572000, "Object":{ "DestObjName":"i_log", "ObjectType":"Table", "SrcObjName":"i_log" }, "RowAvgBytes":0, "ShardID":"", "StartTime":1679299572000, "State":"Completed", "TransferBytes":0, "TransferEstimateBytes":0, "TransferEstimateRows":0, "TransferRows":0 } ], "ProgressType":"Full", "Total":10 }	任务进度的详细信息。

TaskProgress

参数	类型	示例值	描述
ProgressType	String	Full	任务类型。取值如下： Account：表示用户迁移。在 TaskType 取值为 DataMigration 时，支持该取值。 Meta：表示结构迁移、库表结构订阅或结构初始化。 Full：表示全量迁移、全量订阅或全量初始化。 Incr：表示增量迁移、增量订阅或增量初始化。 MigrationAssessment：表示迁移评估进度。
Total	Integer	10	任务的总数量。
AccountProgress	Array of AccountProgressItem	[ { "Account": "`zaizai`@`%`", "Statement": "GRANT REFERENCES ON `huahua`.* TO `zaizai`@`%`;", "state": "Completed", "type": "Privilege" } ]	用户迁移进度。
MetaProgress	Array of MetaProgressItem	[ { "Database": { "DestObjName": "huahua", "ObjectType": "Database", "SrcObjName": "huahua" }, "Ddl": " CREATE DATABASE `huahua` /!40100 DEFAULT CHARACTER SET utf8 /", "FinishTime": 1707191069645339, "Object": { "DestObjName": "auth_operation", "ObjectType": "Table", "SrcObjName": "auth_operation" }, "StartTime": 0, "State": "Completed" } ]	结构迁移、库表结构订阅或结构初始化任务进度。
FullProgress	Array of FullProgressItem	[ { "Database": { "DestObjName": "huahua", "ObjectType": "Database", "SrcObjName": "huahua" }, "FinishTime": 1707191094000, "Object": { "DestObjName": "auth_operation", "ObjectType": "Table", "SrcObjName": "auth_operation" }, "RowAvgBytes": 341, "ShardID": "", "StartTime": 1707191089000, "State": "Completed", "TransferBytes": 5318, "TransferEstimateBytes": 16368, "TransferEstimateRows": 48, "TransferRows": 48 } ]	全量迁移、全量订阅或全量初始化任务进度。
IncrProgress	Array of IncrProgressItem	[ { "Database": { "DestObjName": "test**", "ObjectType": "Database", "SrcObjName": "test" }, "TransferRows": 1, "Object": { "DestObjName": "test", "ObjectType": "Database", "SrcObjName": "test**" }, "TransferBytes": 1, "ShardID": 0, "State": "Completed", "LatencySeconds": 0 } ]	增量迁移、增量订阅或增量同步任务进度。
MigrationAssessmentProgress	Array of MigrationAssessmentProgressItem	[ { "Category": "BasicInfo", "Description": "检查源实例是否含有开启TDE加密的表", "IsLast": false, "ItemCode": "TDE", "ItemName": "源实例 TDE 检查", "ResultInfo": "{\"ResultCode\":\"\",\"EncryptTables\":[]}", "Status": "Success", "StatusDesc": "不存在 TDE 加密的表", "Suggestion": "" } ]	迁移评估任务进度。
DflowRuntimeReadyTimestampMs	Long	0	表示在增量迁移或增量初始化过程中数据流任务被调度系统分发到执行节点的起始时间戳（单位：毫秒）。它标志着任务从“等待调度”进入“实际执行”阶段的起点。
DflowDispatchStartTimestampMs	Long	0	表示在增量迁移或增量初始化过程中数据流任务在执行节点上完成初始化、资源准备就绪、可以开始处理数据的时间戳（单位：毫秒）。它标志着任务从“启动中”进入“可运行”状态的终点。

AccountProgressItem

参数	类型	示例值	描述
Account	String	test****	账号名称。
StartTime	Long	0	用户迁移的开始时间，毫秒时间戳。
FinishTime	Long	1679300319338820	用户迁移的结束时间，毫秒时间戳。
Statement	String	StmtDDLAll	需要传输的 SQL 语句。取值如下： StmtDMLInsert StmtDMLUpdate StmtDMLDelete StmtDDLAll StmtDDLAlterTable StmtDDLAlterView StmtDDLCreateFunction StmtDDLCreateIndex StmtDDLCreateProcedure StmtDDLCreateTable StmtDDLCreateView StmtDDLDropIndex StmtDDLDropTable StmtDDLDropFunction StmtDDLDropProcedure StmtDDLTruncateTable StmtDDLRenameTable StmtDDLDropView
state	String	None	单个任务传输状态。取值如下： None：表示任务待启动。 Transmitting：表示任务传输中。 Completed：表示任务已完成。 Removed：表示任务传输失败。
type	String	Account	用户迁移的类型，取值如下： Account：表示迁移账号。 Privileges：表示迁移账号权限。

MetaProgressItem

参数	类型	示例值	描述
Database	Object of ObjectMapping	{ "DestObjName": "test**", "ObjectType": "Database", "SrcObjName": "test**" }	数据库信息。
Object	Object of ObjectMapping	{ "DestObjName": "test**", "ObjectType": "Database", "SrcObjName": "test**" }	源端和目标端的库表映射对象。
StartTime	Long	0	开始进行库表结构迁移、订阅或初始化的时间，毫秒时间戳。
FinishTime	Long	1679300319338837	库表结构迁移、订阅或初始化的结束时间，毫秒时间戳。
Ddl	String	\nCREATE DATABASE test**** /!40100 DEFAULT CHARACTER SET utf8 /	创建库表结构的操作语句。
State	String	Completed	任务传输状态。取值如下： None：表示任务待启动。 Transmitting：表示任务传输中。 Completed：表示任务已完成。 Removed：表示任务传输失败。

ObjectMapping

参数	类型	示例值	描述
ObjectType	String	Function	对象类型。取值如下： Database：表示数据库。 Table：表示表格。 View：表示视图。 Column：表示列。 Function：表示函数。 Procedure：表示程序。 Trigger：表示触发器。 Type：表示类型。 Domain：表示域名。 Sequence：表示序列。 Rule：表示规则。 Operator：表示操作符。 Aggregate：表示聚合。 Extension：表示扩展。 Constraint：表示约束。 PostSequence：表示 PostgreSQL 的序列。 Schema：表示模式。 Event：表示事件。 DomainConstraint：表示域约束。 BlackTable：表示该表为黑名单表，订阅时被过滤，不同步至目标端。
SrcObjName	String	ceshi****	源端对象名称。说明在参数 ObjectType 取值为 BlackTable时，需填写加入黑名单的表名。
DestObjName	String	test****	目标端对象名称。说明在参数 ObjectType 取值为 BlackTable时，需填写加入黑名单的表名。
MappingList	Array of ObjectMapping	[ { "DestObjName": "test", "MappingList": [ { "DestObjName": "", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ]	传输任务对象。
ObjectMappingSetting	Object of ObjectMappingSetting	{ "ESMetaMappingSetting": { "PidCol": [ "id", "name" ], "EnableRouting": true, "RoutingCol": [ "id" ] } }	在数据同步至 ElasticSearch 时，需配置的其他参数信息。

ObjectMappingSetting

参数	类型	示例值	描述
ESMetaMappingSetting	Object of ESMetaMappingSetting	{ "PidCol": [ "id", "name" ], "EnableRouting": true, "RoutingCol": [ "id" ] }	ElasticSearch 的结构映射参数。
EmbeddingSetting	Object of EmbeddingSetting	{ "EnableEmbedding": true, "VectorFieldName": "age_vector", "VectorType": "FloatVector", "MetricType": "L2", "IndexType": "AUTOINDEX", "KeepOriginalText": true, "OriginalTextNewFieldName": "age" }	表的向量化配置信息。表示将源列数据转换成向量化。
PreVectorizedSetting	Object of PreVectorizedSetting	{ "VectorType": "FloatVector", "MetricType": "L2", "IndexType": "AUTOINDEX", "Dimension": 128, "SourceEncoding": "FloatArray" }	预向量化设置信息。表示源列数据已经完成向量化可直接进行同步。

ESMetaMappingSetting

参数	类型	示例值	描述
PidCol	Array of String	["id", "name"]	主键（_id）取值。当不设置此参数时，默认为主键的列。
EnableRouting	Boolean	EnableRouting	是否启用 Routing，取值如下： true：表示启用 Routing。 false：表示不启用 Routing。
RoutingCol	Array of String	["id"]	_routing 的取值。当 EnableRouting 取值为 true 时，该参数必选。

EmbeddingSetting

参数	类型	示例值	描述
IndexType	String	AUTOINDEX	向量索引类型，当前仅支持设置为 AUTOINDEX。
MetricType	String	L2	度量类型，取值包括：L2、IP、COSINE。
VectorType	String	FloatVector	向量类型，当前仅支持 FloatVector 取值。
EnableEmbedding	Boolean	true	是否开启向量化配置，取值如下： true：表示开启向量化配置。 false：表示不开启向量化配置。
VectorFieldName	String	age_vector	向量化的名称。
KeepOriginalText	Boolean	true	是否保留原文名称，取值如下： true：表示保留原文名称。 false：表示不保留原文名称。
OriginalTextNewFieldName	String	test	原文新列名，为空时表示未作修改保留原文名称。

PreVectorizedSetting

参数	类型	示例值	描述
Dimension	Integer	128	表示向量维度，默认为 128，取值范围 1~32768。
IndexType	String	AUTOINDEX	向量索引类型，当前仅支持设置为 AUTOINDEX。
MetricType	String	L2	度量类型，取值包括：L2、IP、COSINE。
VectorType	String	FloatVector	向量类型，当前仅支持 FloatVector 取值。
SourceEncoding	String	FloatArray	源数据的编码格式，当前仅支持 FloatArray 取值。

FullProgressItem

参数	类型	示例值	描述
Database	Object of ObjectMapping	{ "DestObjName": "test**1", "ObjectType": "Database", "SrcObjName": "test**1" }	数据库信息。
Object	Object of ObjectMapping	{ "DestObjName": "auth_operation", "ObjectType": "Table", "SrcObjName": "auth_operation" }	源端和目标端的库表映射对象。
StartTime	Long	1679300366000	开始进行全量迁移、订阅或初始化的时间，毫秒时间戳。
FinishTime	Long	1679300366000	全量迁移、订阅或初始化的结束时间，毫秒时间戳。
TransferRows	Long	0	传输行数。
TransferBytes	Long	0	传输字节数。
TransferEstimateRows	Long	0	预估行数。
State	String	Completed	任务传输状态。取值如下： None：表示任务待启动。 Transmitting：表示任务传输中。 Completed：表示任务已完成。 Removed：表示任务传输失败。
ShardID	String	0	分片 ID。
RowAvgBytes	Long	0	行平均大小。
TransferEstimateBytes	Long	0	预估总的传输数据量。

IncrProgressItem

参数	类型	示例值	描述
Database	Object of ObjectMapping	{ "DestObjName": "test**", "ObjectType": "Database", "SrcObjName": "test**" }	数据库信息。
Object	Object of ObjectMapping	{ "DestObjName": "test**", "ObjectType": "Database", "SrcObjName": "test**" }	源端和目标端的库表映射对象。
TransferRows	Long	0	传输行数。
TransferBytes	Long	0	传输字节数。
ShardID	String	0	分片 ID。
State	String	Completed	任务传输状态。取值如下： None：表示任务待启动。 Transmitting：表示任务传输中。 Completed：表示任务已完成。 Removed：表示任务传输失败。
LatencySeconds	Long	0	延迟时间，单位：秒（s）。

MigrationAssessmentProgressItem

参数	类型	示例值	描述
Category	String	BasicInfo	评估类别。
ItemCode	String	DBVersion	评估项的唯一标识。
ItemName	String	源实例和目标实例版本	评估项的名称。
Description	String	是否支持源版本向目标版本迁移	评估项的描述信息。
ResultInfo	String	{ "ResultCode":"Success", "SrcDBVersion":"5.6.51", "DstDBVersion":"5.7.32-log" }	评估结果的详细信息。
Status	String	Success	评估项的状态。取值如下： Success：通过 Warn：提示 Failed：不通过
StatusDesc	String	源端：5.6.51，目标端：5.7.32-log	评估结果的说明。
IsLast	Boolean	false	是否为最后一个评估项。 true：表示这是最后一个评估项。 false：表示这不是最后一个评估项。
Suggestion	String	无主键表迁移的影响主要来自两方面：全量迁移中断风险：由于 DTS 无法实现断点续传，迁移过程中若发生中断，需要重新全量同步，显著延长迁移时间并增加源库负载。增量数据不一致：在增量同步阶段，无主键表可能导致重复数据或数据遗漏，造成目标端数据与源端不一致，改进方案建议：添加业务主键：在源端为无主键表添加具有业务意义的唯一标识字段作为主键，确保数据可唯一标识。业务低峰期操作：在业务低峰期执行 ALTER TABLE 操作，通过 ALGORITHM=INPLACE 减少锁表时间。验证数据一致性：迁移完成后使用数据校验工具对比源端和目标端的数据一致性，该方案无需动态修改数据库参数，通过 DDL 操作永久解决无主键表问题，确保迁移数据的完整性和准确性。	评估后给出的优化建议。说明当 Status 的取值为 Success 时，Suggestion内容为空。

示例

请求示例

POST /?Action=DescribeTransmissionTaskProgress&Version=2022-10-01 HTTP/1.1​
Content-Type: application/json​
Host: dts.volcengineapi.com​
X-Date: 20221001T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "TaskId": "af16a602e1134abdbb281864ca******",​
    "ProgressType": "Full",​
    "PageNumber": 1,​
    "PageSize": 1​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230320160648C9A57C0DA2D94117B1C5",​
        "Action": "DescribeTransmissionTaskProgress",​
        "Version": "2022-10-01",​
        "Service": "dts",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "TaskProgress": {​
            "FullProgress": [​
                {​
                    "Database": {​
                        "DestObjName": "test****1",​
                        "ObjectType": "Database",​
                        "SrcObjName": "test****1"​
                    },​
                    "FinishTime": 1679299572000,​
                    "Object": {​
                        "DestObjName": "i_log",​
                        "ObjectType": "Table",​
                        "SrcObjName": "i_log"​
                    },​
                    "RowAvgBytes": 0,​
                    "ShardID": "",​
                    "StartTime": 1679299572000,​
                    "State": "Completed",​
                    "TransferBytes": 0,​
                    "TransferEstimateBytes": 0,​
                    "TransferEstimateRows": 0,​
                    "TransferRows": 0​
                }​
            ],​
            "ProgressType": "Full",​
            "Total": 1​
        }​
    }​
}​

错误码

更多详情，请参见错误码。

数据库传输服务