查询结构对比预检查状态
查询指定结构对比任务的预检查状态和检查项结果。
请求地址:/openapi/v1/compareschema/precheck/status
请求方法:GET
调用前准备
请求参数
| 参数 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| taskId | String | 是 | 结构对比任务 ID。 | cc-th6j3fs58y |
| precheckTaskId | String | 是 | 预检查任务 ID。 | pcte-dji009w2k499 |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID,可用于问题排查和链路追踪。 | Pc2k1HKI-CIJDvWQnEIIb9GFdDHg0IUT |
| data | Object | 预检查状态对象,字段见下方说明。 | 见下方示例 |
| message | String | 错误信息。请求失败时返回。 | precheck task not found |
data 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| taskId | String | 结构对比任务 ID。 | cc-th6j3fs58y |
| precheckTaskId | String | 预检查任务 ID。 | pcte-dji009w2k499 |
| status | String | 预检查状态。取值包括 Unstarted、Running、Failed、Success。 | Success |
| precheckItems | Array | 各预检查项的执行状态、失败原因和修复建议。 | 见下方字段说明 |
precheckItems 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| precheckItem | String | 检查项标识。 | srcDataSourceCheck |
| itemName | String | 检查项名称。 | Source Connection Check |
| itemDescription | String | 检查项描述。 | Check the status of the gateway... |
| status | String | 检查项状态。取值包括 Unstarted、Running、Failed、Success。 | Success |
| errorMessage | String | 检查失败时的原因和修复建议。 | Please check datasource privileges. |
请求示例
{
"taskId": "cc-th6j3fs58y",
"precheckTaskId": "pcte-dji009w2k499"
}
调用成功示例
{
"success": true,
"requestId": "Pc2k1HKI-CIJDvWQnEIIb9GFdDHg0IUT",
"data": {
"taskId": "cc-th6j3fs58y",
"precheckTaskId": "pcte-dji009w2k499",
"status": "Success",
"precheckItems": [
{
"precheckItem": "srcDataSourceCheck",
"itemName": "Source Connection Check",
"itemDescription": "Check the status of the gateway of the source datasource, database connectable, and verify the username and password",
"status": "Success"
}
]
}
}