Query Schema Comparison Precheck Status

Query the precheck status and check item results for a schema comparison task.

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

Request Method: GET

Before You Call

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

Request Parameters

Parameter	Type	Required	Description	Example
taskId	String	Yes	Schema comparison task ID.	cc-th6j3fs58y
precheckTaskId	String	Yes	Precheck task ID.	pcte-dji009w2k499

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.	Pc2k1HKI-CIJDvWQnEIIb9GFdDHg0IUT
data	Object	Precheck status object. See the fields below.	See the example below
message	String	Error message returned when the request fails.	precheck task not found

data Fields

Parameter	Type	Description	Example
taskId	String	Schema comparison task ID.	cc-th6j3fs58y
precheckTaskId	String	Precheck task ID.	pcte-dji009w2k499
status	String	Precheck status. Valid values include Unstarted, Running, Failed, and Success.	Success
precheckItems	Array	Execution status, failure reason, and suggested fix for each precheck item.	See the fields below

precheckItems Fields

Parameter	Type	Description	Example
precheckItem	String	Check item identifier.	srcDataSourceCheck
itemName	String	Check item name.	Source Connection Check
itemDescription	String	Check item description.	Check the status of the gateway...
status	String	Check item status. Valid values include Unstarted, Running, Failed, and Success.	Success
errorMessage	String	Failure reason and suggested fix returned when the check item fails.	Please check datasource privileges.

Request Example

{
  "taskId": "cc-th6j3fs58y",
  "precheckTaskId": "pcte-dji009w2k499"
}

Successful Invocation Example

{
  "success": true,
  "requestId": "Pc2k1HKI-CIJDvWQnEIIb9GFdDHg0IUT",
  "data": {
    "taskId": "cc-th6j3fs58y",
    "precheckTaskId": "pcte-dji009w2k499",
    "status": "Success",
    "precheckItems": [
      {
        "precheckItem": "srcDataSourceCheck",
        "itemName": "Source Connection Check",
        "itemDescription": "Check the status of the gateway of the source datasource, database connectable, and verify the username and password",
        "status": "Success"
      }
    ]
  }
}