跳到主要内容

停止结构对比任务

停止指定的结构对比任务。

请求地址:/openapi/v1/compareschema/stop

请求方法:POST

调用前准备

taskId 可通过 创建结构对比任务 的成功响应 data.taskId 获取,也可以通过 查询结构对比任务列表 返回的 data.schemaComparisons[].taskId 确认。

请求参数

参数类型是否必填说明示例
taskIdString需要停止的结构对比任务 ID。cc-th6j3fs58y

请求示例

{
"taskId": "cc-th6j3fs58y"
}

返回参数

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID,可用于问题排查和链路追踪。Ui2v5MWG-GMNHlLPnIMMw6DRdHNr9BGD
messageString错误信息。请求失败时返回。task not found

调用成功示例

{
"success": true,
"requestId": "Ui2v5MWG-GMNHlLPnIMMw6DRdHNr9BGD"
}