查询全量或增量校验任务详情 - 数据传输服务 DTS

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDataCheckTableDetails	系统规定参数。取值：DescribeDataCheckTableDetails。
Status	String	否	-1	校验结果对应的状态，取值为： -1（默认值）：所有状态。 6：存在不一致数据的表。
PageSize	Integer	否	10	每页记录数。
PageNumber	Integer	否	1	页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。
CheckType	Integer	是	1	数据校验方式，取值： 1：全量校验。 2：增量校验。
TableName	String	否	student	源数据库中校验的表名。
DtsJobId	String	是	xd4e4xb419q****	迁移或同步任务ID，您可以调用DescribeDtsJobs接口查询。
SchemaName	String	否	dtstest	源数据库中校验对象的Schema名称。

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	状态码。
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	请求ID。
ErrCode	String	InternalError	调用出错时返回的错误码。
Success	Boolean	true	请求是否成功。
ErrMessage	String	The Value of Input Parameter %s is not valid.	调用错误时返回的错误信息。
DynamicMessage	String	Type	动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。说明如果ErrMessage返回The Value of Input Parameter %s is not valid，且DynamicMessage返回Type，则代表所传入的请求参数Type不合法。
PageNumber	Integer	2	页码。
DynamicCode	String	403	动态错误码，本参数即将下线。
TableDetails	Array of TableDetails		数据表校验的结果详情。
Status	String	0	校验结果对应的状态，返回值为： 0：已完成。 2：初始化中。 3：运行中。 5：失败。
Id	Long	167401241974****	用于标识一条校验结果数据的自增主键。
SourceDbName	String	testdb	源端数据库名称。
TargetDbName	String	testdb	目标端数据库名称。
SourceTbName	String	student	源端表名称。
TargetTbName	String	person	目标端表名称。
TotalCount	Long	8	校验数据的总行数。
FinishCount	Long	7	表中已完成校验的数据行数。
DiffCount	Long	1	数据不一致的行数。
BootTime	String	2023-01-18 11:26:59	进行校验的时间。
ErrorCode	Integer	1	任务运行出错时，返回报错信息的错误编码。 1：无主键表的数量超过限制。 2：差异数据超过300行。 3：待查询的表不存在。 4：查询数据的SQL语法错误。
TotalCount	Long	1	校验的表的总数量。
FinishedCount	Long	7	累计已完成校验的数据行数。
DiffTableCount	Long	1	数据不一致表的数量。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeDataCheckTableDetails
&CheckType=2
&DtsJobId=xd4e4xb419q****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDataCheckTableDetailsResponse>
    <DiffTableCount>1</DiffTableCount>
    <TableDetails>
        <Status>0</Status>
        <SourceTbName>student</SourceTbName>
        <TotalCount>8</TotalCount>
        <TargetTbName>person</TargetTbName>
        <TargetDbName>testdb</TargetDbName>
        <FinishCount>7</FinishCount>
        <BootTime>2023-04-23 18:35:05</BootTime>
        <Id>1682246105030001</Id>
        <SourceDbName>testdb</SourceDbName>
        <DiffCount>1</DiffCount>
    </TableDetails>
    <TotalCount>1</TotalCount>
    <RequestId>B8BCB980-CDC2-5628-A6F0-AB1910AA****</RequestId>
    <PageNumber>1</PageNumber>
    <FinishedCount>7</FinishedCount>
    <HttpStatusCode>200</HttpStatusCode>
    <Success>true</Success>
</DescribeDataCheckTableDetailsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DiffTableCount" : 1,
  "TableDetails" : [ {
    "Status" : 0,
    "SourceTbName" : "student",
    "TotalCount" : 8,
    "TargetTbName" : "person",
    "TargetDbName" : "testdb",
    "FinishCount" : 7,
    "BootTime" : "2023-04-23 18:35:05",
    "Id" : 1682246105030001,
    "SourceDbName" : "testdb",
    "DiffCount" : 1
  } ],
  "TotalCount" : 1,
  "RequestId" : "B8BCB980-CDC2-5628-A6F0-AB1910AA****",
  "PageNumber" : 1,
  "FinishedCount" : 7,
  "HttpStatusCode" : 200,
  "Success" : true
}

错误码

HttpCode	错误码	错误信息	描述
400	Throttling.User	Request was denied due to user flow control.	由于请求频次达到阈值，请求被拒绝，请稍后重试。
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	签名已经过期，请更新签名

访问错误中心查看更多错误码。