Skip to main content

Stop Data Comparison Task

Use this API to stop a specified data comparison task. Stop a task when you no longer want the current comparison execution to continue.

Request URL: /openapi/v1/comparedata/stop

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-tepmjmnj6o"
}

Request Parameters​

ParameterTypeRequiredDescriptionExample
taskIdStringYesID of the comparison task to stop.cd-tepmjmnj6o

Response Parameters​

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID, which can be used for troubleshooting and tracing.Bi6n4OVJ-FLLMjGBnGGNh9RSdHJx3HJT

Successful Invocation Example​

{
"success": true,
"requestId": "Bi6n4OVJ-FLLMjGBnGGNh9RSdHJx3HJT"
}

Result​

A successful response confirms that the stop request was accepted. Query the data comparison task or subtask details afterward if your automation needs to confirm the latest task state.