---
title: "查询预检查结果 | OceanBase 文档中心"
description: 查询预检查结果 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：查询预检查结果 GetPreCheckResult。 功能说明 本接口用于查询数据迁移或数据同步任务的预检查结果。 调用说明 接口约束 本接口适用于 OMS V4.2.2…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*L03BS6f-o40AAAAAAAAAAAAADiGDAQ/original) 迁移服务 OMSV 4.3.1 企业版

# 查询预检查结果

更新时间：2026-04-14 15:36:02

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：查询预检查结果 GetPreCheckResult。

## 功能说明

本接口用于查询数据迁移或数据同步任务的预检查结果。

## 调用说明

### 接口约束

本接口适用于 OMS V4.2.2 及之后版本。

### 请求路径

`POST /api/v2?Action=GetPreCheckResult`

### 请求参数

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 预检查 ID，即 [任务预检查](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-1000000004023251) 接口返回的 `data`。 |

### 返回结果

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| success | boolean | 是否调用成功。 |
| errorDetail | object | 错误详情。 |
| code | string | 错误码。 |
| message | string | 描述信息。 |
| advice | string | 建议。 |
| requestId | string | 请求 ID。 |
| pageNumber | integer | 页序号，分页查询时生效。 |
| pageSize | integer | 页大小，分页查询时生效。 |
| totalCount | integer | 总数，分页查询时生效。 |
| cost | string | 请求耗时，单位为秒。 |
| data | object [] | 预检查结果详情。具体包含的信息请参见《data 数据结构》。 |

**data 数据结构**

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| projectId | string | 数据迁移、数据同步或数据校验任务的 ID。 |
| projectStatus | string | 任务的状态，包括 INIT、PENDING、RUNNING、FAILED、FINISHED 和 SKIPPED。 |
| preCheckResults | object | 预检查项的结果。 |
| ├─ name | string | 预检查项的名称。例如，`源端-主库-数据库连通性检查`。 |
| ├─ endpointType | string | 数据源的类型，包括 `SOURCE`（源端）和 `DEST`（目标端）。 |
| ├─ checkType | string | 预检查项的类型。 |
| ├─ status | string | 预检查项的状态。 |
| ├─ message | string | 预检查项的具体信息。 |
| ├─ skippable | boolean | 是否跳过预检查项。 |
| ├─ role | string | 数据库属性，包括 **主库**、**主库+备库** 和 **备库**。 |
| ├─ skipConsequence | string | 跳过预检查项的结果。 |
| ├─ errorDetail | string | 预检查项的错误信息。 |
| ├─ removable | boolean | 是否支持移除待迁移或同步的对象。 |
| ├─ blackObjectsInfo | object | 需要移除的迁移或同步对象。 |
| progress | decimal | 预检查项的进度百分比。 |

## 示例

### 请求示例

```JSON
{
  "id": "t_57p****"
}

```

### 返回示例

```JSON
{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "bf2-9bc9-****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "126 ms",
    "data": {
        "projectId": "t_57p****",
        "projectStatus": "FINISHED",
        "preCheckResults": [
            {
                "name": "源端-主库-数据库连通性检查",
                "endpointType": "SOURCE",
                "checkType": "RDB_CONNECT",
                "status": "PASSED",
                "message": null,
                "skippable": false,
                "role": "MASTER",
                "skipConsequence": null,
                "errorDetail": null,
                "removable": false,
                "blackObjectsInfo": null
            },
            {
                "name": "源端-主库-数据库存在性检查",
                "endpointType": "SOURCE",
                "checkType": "RDB_SCHEMA_EXIST",
                "status": "PASSED",
                "message": null,
                "skippable": false,
                "role": "MASTER",
                "skipConsequence": null,
                "errorDetail": null,
                "removable": false,
                "blackObjectsInfo": null
            }
        ],
        "progress": 100.0
    }
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线
