Skip to main content

Start Data Comparison Precheck

Start the precheck for a specified data comparison task. The precheck verifies whether source and target connections, privileges, and related conditions meet data comparison requirements.

Request URL: /openapi/v1/comparedata/precheck/start

Request Method: POST

Before You Call​

taskId can be obtained from data in the successful response of Create Data Comparison Task, or confirmed through data.id returned by Query Data Comparison Main Task Details.

Request Body​

{
"taskId": "cd-tg3isu1xgs"
}

Request Parameters​

ParameterTypeRequiredDescriptionExample
taskIdStringYesID of the data comparison task for which to start the precheck.cd-tg3isu1xgs

Response Parameters​

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID, which can be used for troubleshooting and tracing.Fj2z8KDA-kqqraVGnllse6BZdmnh5DQM
dataObjectPrecheck task information.See the field descriptions below

data Fields​

ParameterTypeDescriptionExample
taskIdStringID of the data comparison task for which the precheck is started.cd-tg3isu1xgs
precheckTaskIdStringID of the submitted precheck task. Use this value to query the precheck status.pcte-dj02vti9tabd

Successful Invocation Example​

{
"success": true,
"requestId": "Fj2z8KDA-kqqraVGnllse6BZdmnh5DQM",
"data": {
"taskId": "cd-tg3isu1xgs",
"precheckTaskId": "pcte-dj02vti9tabd"
}
}

Result​

A successful response returns precheckTaskId, which identifies the submitted precheck. Use this value to query the precheck status before starting the data comparison task.