You need to enable JavaScript to run this app.
文档中心
数据库传输服务

数据库传输服务

复制全文
下载 pdf
数据校验
DescribeValidationTaskResult
复制全文
下载 pdf
DescribeValidationTaskResult
调用 DescribeValidationTaskResult 接口查看数据校验结果。
请求类型
同步请求。
请求参数
参数
类型
是否必选
示例值
描述
TaskId
String
4aba0b3ce6a24aff82da259e27******
校验任务 ID。
说明
调用 DescribeDataValidationTasks接口查询数据校验任务 ID。
PageNumber
Integer
1
页码。取值范围 1~1000,默认值为 1。
PageSize
Integer
10
每页记录数。取值范围 1~1000,默认值为 10。
返回参数
参数
类型
示例值
描述
ValidationResult
Object of ValidationResult
{
"FileState": "Unknown",
"FullValidationResult": [
{
"DiffNum": 0,
"EstimateNum": 100000,
"FinishTime": 1733964705706,
"StartTime": 1733964542000
}
],
"TaskSubType": "FullRowCompare",
"Total": 1,
"TotalDiffNum": 0
}
}
数据校验的结果信息。
ValidationResult
参数
类型
示例值
描述
FileState
String
Unknown
Diff 文件是否已生成,取值如下:
  • Unknown:表示没有 Diff 数据文件生成。
  • Generating:表示正在生成 Diff 文件。
  • Generated:表示已生成 Diff 文件,且支持下载。
TaskSubType
String
FullRowCompare
数据校验任务类型,取值如下:
  • FullRowCompare:表示全量内容校验。
  • FullRowCountCompare:表示全量行数校验。
  • FullPkCompare:表示全量主键校验。
  • MetaCompare:表示结构校验。
  • IncrDataValidation:表示增量校验。
TotalDiffNum
Long
0
不一致总对象数。
FullValidationResult
[
{
"DiffNum": 0,
"EstimateNum": 101439,
"FinishTime": 1733962493369,
"StartTime": 1733961817000,
"Database": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
},
"Object": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
}
]
全量内容校验结果。
PkValidationResult
[
{
"DiffNum": 0,
"EstimateNum": 1,
"FinishTime": 1733822797540,
"StartTime": 1733822724000,
"Database": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
},
"Object": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
}
]
全量主键校验结果。
RowCountValidationResult
[
{
"DestNum": 65000000,
"DiffNum": 0,
"FinishTime": 1733909914252,
"SrcNum": 65000000,
"StartTime": 1733909810000
}
]
全量行数校验结果。
IncrValidationResult
[
{
"DiffNum": 0,
"FinishTime": 1733822797540,
"StartTime": 1733822724000,
"Database": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
},
"Object": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
}
]
增量校验结果。
MetaValidationResult
[
{
"ErrorNum": 0,
"FinishTime": 1733909874137,
"StartTime": 1733909860000,
"WarnNum": 0,
"Database": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
},
"Object": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
}
]
结构校验结果。
Total
Integer
1
校验任务中库表异常的数量。
FullValidationResultItem
参数
类型
示例值
描述
DiffNum
Long
0
不一样的总数据量。
EstimateNum
Long
100000
预估总行数。
FinishTime
Long
1733962493369
全量数据校验的结束时间,使用毫秒时间戳格式。
StartTime
Long
1733961817000
全量数据校验的开始时间,使用毫秒时间戳格式。
Database
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
数据库信息。
Object
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
源端和目标端的库表映射对象。
ObjectMapping
参数
类型
示例值
描述
ObjectType
String
Function
对象类型。取值如下:
  • Database:表示数据库。
  • Table:表示表格。
  • View:表示视图。
  • Column:表示列。
  • Function:表示函数。
  • Procedure:表示程序。
  • Trigger:表示触发器。
  • Type:表示类型。
  • Domain:表示域名。
  • Sequence:表示序列。
  • Rule:表示规则。
  • Operator:表示操作符。
  • Aggregate:表示聚合。
  • Extension:表示扩展。
  • Constraint:表示约束。
  • PostSequence:表示 PostgreSQL 的序列。
  • Schema:表示模式。
  • Event:表示事件。
  • DomainConstraint:表示域约束。
SrcObjName
String
ceshi****
源端对象名称。
DestObjName
String
test****
目标端对象名称。
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
{
"ESMetaMappingSetting": {
"PidCol": [
"id",
"name"
],
"EnableRouting": true,
"RoutingCol": [
"id"
]
}
}
在数据同步至 ElasticSearch 时,需配置的其他参数信息。
ObjectMappingSetting
参数
类型
示例值
描述
ESMetaMappingSetting
{
"PidCol": [
"id",
"name"
],
"EnableRouting": true,
"RoutingCol": [
"id"
]
}
ElasticSearch 的结构映射参数。
ESMetaMappingSetting
参数
类型
示例值
描述
PidCol
Array of String
["id", "name"]
主键(_id)取值。当不设置此参数时,默认为主键的列。
EnableRouting
Boolean
EnableRouting
是否启用 Routing,取值如下:
  • true:表示启用 Routing。
  • false:表示不启用 Routing。
RoutingCol
Array of String
["id"]
_routing 的取值。当 EnableRouting 取值为 true 时,该参数必选。
PkValidationResultItem
参数
类型
示例值
描述
DiffNum
Long
0
全量主键校验任务不一致数量的总数。
EstimateNum
Long
1
全量主键校验任务的预估总行数。
FinishTime
Long
1733822797540
全量数据校验任务的结束时间,使用毫秒时间戳。
StartTime
Long
1733822724000
全量数据校验任务的开始时间,使用毫秒时间戳。
Database
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
数据库信息。
Object
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
源端和目标端的库表映射对象。
RowCountValidationResultItem
参数
类型
示例值
描述
SrcNum
Long
65000000
全量行数校验任务的源端行数。
DestNum
Long
65000000
全量行数校验任务的目标端行数。
DiffNum
Long
0
全量行数校验任务的不一致行数。
FinishTime
Long
1733909914252
全量行数校验任务的结束时间,使用毫秒戳时间格式。
StartTime
Long
1733909810000
全量行数校验任务的开始时间,使用毫秒戳时间格式。
Database
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
数据库信息。
Object
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
源端和目标端的库表映射对象。
IncrValidationResultItem
参数
类型
示例值
描述
DiffNum
Long
0
增量校验任务的不一致行数。
StartTime
Long
1733909914252
增量校验任务的开始时间,使用毫秒戳时间格式。
FinishTime
Long
1733909810000
增量校验任务的结束时间,使用毫秒戳时间格式。
Database
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
数据库信息。
Object
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
源端和目标端的库表映射对象。
MetaValidationResultItem
参数
类型
示例值
描述
ErrorNum
Long
0
结构校验任务结果中出现错误类型的不一致数据量。
FinishTime
Long
1733909874137
结构校验任务的结束时间,使用毫秒时间戳格式。
StartTime
Long
1733909860000
结构校验任务的开始时间,使用毫秒时间戳格式。
WarnNum
Long
0
结构校验任务结果中出现警告类型的不一致数据量。
Database
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
数据库信息。
Object
Object of ObjectMapping
{
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
源端和目标端的库表映射对象。
示例
请求示例
POST /?Action=DescribeValidationTaskResult&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host: dts.cn-beijing.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
"TaskId": "b75b64b9fd134026a18420f3******",
"PageNumber": 1,
"PageSize": 10
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20241217142238DFA631C9D4A54ACA0885-542ca0",
"Action": "DescribeValidationTaskResult",
"Version": "2022-10-01",
"Service": "dts",
"Region": "cn-beijing"
},
"Result": {
"ValidationResult": {
"FileState": "Generated",
* "FullValidationResult": [
{
"DiffNum": 5441,
"EstimateNum": 199796,
"FinishTime": 1734387280919,
"StartTime": 1734387225000,
"Database": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
},
"Object": {
"DestObjName": "test****",
"ObjectType": "Database",
"SrcObjName": "test****"
}
}
],
"TaskSubType": "FullRowCompare",
"Total": 1,
"TotalDiffNum": 5441
}
}
}
错误码
更多详情,请参见错误码
最近更新时间:2026.03.16 16:04:13
这个页面对您有帮助吗?
有用
有用
无用
无用