Stop Schema Comparison Task
Use this API to stop a specified schema comparison task. Stop a task when you no longer want the current schema comparison execution to continue.
Request URL: /openapi/v1/compareschema/stop
Request Method: POST
Before You Call
taskId can be obtained from data.taskId in the successful response of Create Schema Comparison Task, or from data.schemaComparisons[].taskId returned by List Schema Comparison Tasks.
Request Body
{
"taskId": "cc-th6j3fs58y"
}
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| taskId | String | Yes | Schema comparison task ID to stop. | 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. | Ui2v5MWG-GMNHlLPnIMMw6DRdHNr9BGD |
| message | String | Error message returned when the request fails. | task not found |
Successful Invocation Example
{
"success": true,
"requestId": "Ui2v5MWG-GMNHlLPnIMMw6DRdHNr9BGD"
}
Result
A successful response confirms that the stop request was accepted. Query schema comparison task or subtask details afterward if your automation needs to confirm the latest task state.