Query Data Comparison Precheck Status

Query the execution status and check item results of a specified data comparison precheck task.

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

Request Method: GET

Before You Call

• taskId can be obtained from data in the successful response of Create Data Comparison Task.
• precheckTaskId can be obtained from data.precheckTaskId in the successful response of Start Data Comparison Precheck.

Request Parameters

Parameter	Type	Required	Description	Example
taskId	String	Yes	ID of the data comparison task whose precheck status you want to query.	cd-tg3isu1xgs
precheckTaskId	String	Yes	ID of the precheck task to query.	pcte-dj02vti9tabd

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request is successful.	true
requestId	String	Request ID, which can be used for troubleshooting and tracing.	Lu8t2KPM-eqqraVGnllse6BZdmnh5DQM
data	Object	Precheck status object.	See the field descriptions below

data Fields

Parameter	Type	Description	Example
taskId	String	Data comparison task ID.	cd-tg3isu1xgs
precheckTaskId	String	Precheck task ID.	pcte-dj02vti9tabd
status	String	Precheck task status. Valid values: Unstarted, Running, Failed, and Success.	Success
precheckItems	Array	List of precheck items, including each item's status, failure reason, and remediation suggestion.	See the field descriptions below

precheckItems Fields

Parameter	Type	Description	Example
precheckItem	String	Check item identifier.	targetDataExistCheck
status	String	Check item status. Valid values: Unstarted, Running, Failed, and Success.	Success
errorMessage	String	Failure reason and remediation suggestion returned when the check item fails.	Target tables are missing _sign and _version columns. Add the columns and run the precheck again.
itemName	String	Check item name.	Source database privilege check
itemDescription	String	Check item description.	Check whether the account privileges of the source database meet the requirements

Request Example

{
  "taskId": "cd-tg3isu1xgs",
  "precheckTaskId": "pcte-dj02vti9tabd"
}

Successful Invocation Example

{
  "success": true,
  "requestId": "Lu8t2KPM-eqqraVGnllse6BZdmnh5DQM",
  "data": {
    "taskId": "cd-tg3isu1xgs",
    "precheckTaskId": "pcte-dj02vti9tabd",
    "status": "Success",
    "precheckItems": [
      {
        "precheckItem": "compareSrcPermissionCheck",
        "itemName": "Source database privilege check",
        "itemDescription": "Check whether the account privileges of the source database meet the requirements",
        "status": "Success"
      },
      {
        "precheckItem": "targetDataSourceCheck",
        "itemName": "Target Connection Check",
        "itemDescription": "Check the status of the gateway of the target datasource, database connectable, and verify the username and password",
        "status": "Success"
      }
    ]
  }
}