All Products
Search
Document Center

Data Transmission Service:DescribeDataCheckReportUrl

最終更新日:Feb 05, 2024

Queries the download URL of a data verification report. You can obtain inconsistency data in a data verification report if inconsistency is detected between the source and destination databases.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DescribeDataCheckReportUrl

The operation that you want to perform. Set the value to DescribeDataCheckReportUrl.

CheckType

Integer

Yes

1

The data verification method. Valid values:

  • 1: full data verification

DbName

String

Yes

dtsdb

The name of the source database.

TbName

String

Yes

student

The name of the table whose data is verified in the source database.

DtsJobId

String

Yes

f4612nr2182****

The ID of the DTS task. You can call the DescribeDtsJobs operation to query the ID.

Response parameters

Parameter

Type

Example

Description

RequestId

String

AF2DE23-B692-5B85-90B7-44B6F4D8****

The request ID.

ErrCode

String

InternalError

The error code returned if the request failed.

Success

String

true

Indicates whether the request was successful.

ErrMessage

String

The Value of Input Parameter %s is not valid.

The error message returned if the request failed.

DynamicMessage

String

https://check-result-file-sh.oss-cn-shanghai.aliyuncs.com/dw612cru18e****/dtsdb/diff/student.diff.zip?Expires=****

The download URL of the data verification report.

HttpStatusCode

Integer

200

The status code.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeDataCheckReportUrl
&CheckType=1
&DbName=dtsdb
&TbName=student
&DtsJobId=f4612nr2182****
&Common request parameters

Sample success responses

XML format

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

<DescribeDataCheckReportUrlResponse>
    <RequestId>7DF6862F-E666-5509-AE36-C5E745A1****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <DynamicMessage>https://check-result-file-sh.oss-cn-shanghai.aliyuncs.com/dw612cru18e****/dtsdb/diff/student.diff.zip?Expires=****</DynamicMessage>
    <ErrMessage/>
    <Success>true</Success>
    <ErrCode/>
</DescribeDataCheckReportUrlResponse>

JSON format

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

{
  "RequestId" : "7DF6862F-E666-5509-AE36-C5E745A1****",
  "HttpStatusCode" : 200,
  "DynamicMessage" : "https://check-result-file-sh.oss-cn-shanghai.aliyuncs.com/dw612cru18e****/dtsdb/diff/student.diff.zip?Expires=****",
  "ErrMessage" : "",
  "Success" : true,
  "ErrCode" : ""
}

Error codes

HTTP status code

Error code

Error message

Description

403

DTS.Msg.FileExistValidFailError

The file has not been generated, please try again later.

The file has not been generated. Try again later.

403

InvalidSecurityToken.Expired

Specified SecurityToken is expired.

The signature expired. Use a new signature.

400

Throttling.User

Request was denied due to user flow control.

The number of requests exceeded the limit, and the request was rejected. Try again later.

500

ServiceUnavailable

The request has failed due to a temporary failure of the server.

The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.

For a list of error codes, see Service error codes.