跳到主要内容

启动结构对比预检查

启动指定结构对比任务的预检查。

请求地址:/openapi/v1/compareschema/precheck/start

请求方法:POST

调用前准备

taskId 可通过 创建结构对比任务 的成功响应 data.taskId 获取。

请求参数

参数类型是否必填说明示例
taskIdString需要启动预检查的结构对比任务 ID。cc-th6j3fs58y

请求示例

{
"taskId": "cc-th6j3fs58y"
}

返回参数

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID,可用于问题排查和链路追踪。Dm7u8WSZ-jpqkhAMnlpps5BKdkon8JAV
dataObject预检查启动结果,字段见下方说明。见下方示例
messageString错误信息。请求失败时返回。task not found

data 字段说明

参数类型说明示例
taskIdString结构对比任务 ID。cc-th6j3fs58y
precheckTaskIdString本次提交的预检查任务 ID。pcte-dji009w2k499

调用成功示例

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