Start Schema Comparison Precheck

Use this API to start the precheck for a specified schema comparison task. The precheck helps verify whether the task is ready before you start schema comparison execution.

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

Request Method: POST

Before You Call

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

Request Body

{
  "taskId": "cc-th6j3fs58y"
}

Request Parameters

Parameter	Type	Required	Description	Example
taskId	String	Yes	Schema comparison task ID for which to start the precheck.	cc-th6j3fs58y

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.	Dm7u8WSZ-jpqkhAMnlpps5BKdkon8JAV
data	Object	Precheck start result. See the fields below.	See the example below
message	String	Error message returned when the request fails.	task not found

data Fields

Parameter	Type	Description	Example
taskId	String	Schema comparison task ID.	cc-th6j3fs58y
precheckTaskId	String	Precheck task ID submitted this time.	pcte-dji009w2k499

Successful Invocation Example

{
  "success": true,
  "requestId": "Dm7u8WSZ-jpqkhAMnlpps5BKdkon8JAV",
  "data": {
    "taskId": "cc-th6j3fs58y",
    "precheckTaskId": "pcte-dji009w2k499"
  }
}

Result

A successful response returns precheckTaskId, which identifies the submitted precheck. Use this value to query the schema comparison precheck status.