---
title: "下载表结构转换信息 | OceanBase 文档中心"
description: 下载表结构转换信息 OceanBase 迁移服务（OceanBase Migration Service，OMS）支持下载结构迁移完成后有转换的表的结构转换信息。本文为您介绍实现该功能涉及的三个 OpenAPI： CheckHasConvertedObjects 、 DownloadConvertedObjectsA…
---
切换语言

- 中文站 - 简体中文
- 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：`CheckHasConvertedObjects`、`DownloadConvertedObjectsAsync` 和 `GetDownloadConvertedObjectsResult`。

## 功能说明

- `CheckHasConvertedObjects` 接口用于检查当前任务是否支持下载可转换对象。

  当返回结果中 `isDownloading` 为 `false`，`hasConvertedObjects` 为 `true` 时支持下载。
 - `DownloadConvertedObjectsAsync` 接口用于开启一个可转换对象信息下载任务。

  返回结果中的 `data` 为任务 ID，`GetDownloadConvertedObjectsResult` 接口会进行调用。
 - `GetDownloadConvertedObjectsResult` 接口用于获取当前可转换对象信息下载任务的结果。

  请求参数为 `DownloadConvertedObjectsAsync` 接口的返回值。当 `data` 中的 `code` 为 `FINISHED` 时，表示该任务已完成下载，结果会展示在 `csvResult` 中。

    CheckHasConvertedObjects

## 调用说明

### 接口约束

`CheckHasConvertedObjects` 接口适用于 OMS V4.3.0 及之后版本。

### 请求路径

`POST /api/v2?Action=CheckHasConvertedObjects`

### 请求参数

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 数据迁移任务的 ID。例如，`np_4w3a****`。 |

### 返回结果

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| success | boolean | 是否调用成功。 |
| errorDetail | object | 错误详情。 |
| code | string | 错误码。 |
| message | string | 描述信息。 |
| advice | string | 建议。 |
| requestId | string | 请求 ID。 |
| pageNumber | integer | 页序号，分页查询时生效。 |
| pageSize | integer | 页大小，分页查询时生效。 |
| totalCount | integer | 总数，分页查询时生效。 |
| cost | string | 请求耗时，单位为秒。 |
| data | object [] | 返回结果。 |
| ├─ isDownloading | boolean | 是否在下载中。 |
| ├─ hasConvertedObjects | boolean | 是否有转换对象可以下载。 |

## 示例

### 请求示例

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

```

### 返回示例

```JSON
{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "94665a90-8****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": null,
    "data": {
        "isDownloading": false,
        "hasConvertedObjects": false
    }
}

```

Tab DownloadConvertedObjectsAsync

## 调用说明

### 接口约束

`DownloadConvertedObjectsAsync` 接口适用于 OMS V4.3.0 及之后版本。

### 请求路径

`POST /api/v2?Action=DownloadConvertedObjectsAsync`

### 请求参数

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| projectId | string | 数据迁移任务的 ID。 |
| onlyConverted | boolean | 是否仅下载转换信息，可选值包括 `true` 和 `false`。   - `true`：表示下载转换信息和表名称。 - `false`：表示下载转换信息、表名称和表 DDL。 |

### 返回结果

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| success | boolean | 是否调用成功。 |
| errorDetail | object | 错误详情。 |
| code | string | 错误码。 |
| message | string | 描述信息。 |
| advice | string | 建议。 |
| requestId | string | 请求 ID。 |
| pageNumber | integer | 页序号，分页查询时生效。 |
| pageSize | integer | 页大小，分页查询时生效。 |
| totalCount | integer | 总数，分页查询时生效。 |
| cost | string | 请求耗时，单位为秒。 |
| data | string | 可转换对象信息下载任务的 ID。 |

## 示例

### 请求示例

```JSON
{
    "projectId":"np_4w3a****",
    "onlyConverted": true
}

```

### 返回示例

```JSON
{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "94665a90-8****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": null,
    "data": "t_6m****"
}

```

Tab GetDownloadConvertedObjectsResult

## 调用说明

### 接口约束

`GetDownloadConvertedObjectsResult` 接口适用于 OMS V4.3.0 及之后版本。

### 请求路径

`POST /api/v2?Action=GetDownloadConvertedObjectsResult`

### 请求参数

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 可转换对象信息下载任务的 ID，是 `DownloadConvertedObjectsAsync` 接口的返回值。例如，`t_6mx****`。 |

### 返回结果

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| success | boolean | 是否调用成功。 |
| errorDetail | object | 错误详情。 |
| code | string | 错误码。 |
| message | string | 描述信息。 |
| advice | string | 建议。 |
| requestId | string | 请求 ID。 |
| pageNumber | integer | 页序号，分页查询时生效。 |
| pageSize | integer | 页大小，分页查询时生效。 |
| totalCount | integer | 总数，分页查询时生效。 |
| cost | string | 请求耗时，单位为秒。 |
| data | object [] | 返回结果。 |
| ├─ csvResult | string | 可转换对象信息下载任务的结果。 |
| ├─ message | string | 可转换对象下载信息任务的描述信息。 |
| ├─ code | string | 可转换对象信息下载任务的状态，可选值包括 `PENDING`、`RUNNING`、`FINISHED` 和 `FAILED`。   - `PENDING`：表示该任务待开始下载。 - `RUNNING`：表示该任务在下载中。 - `FINISHED`：表示该任务已经下载完成，结果会展示在 `csvResult` 中。 - `FAILED`：表示该任务下载失败，任务已结束。 |

## 示例

### 请求示例

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

```

### 返回示例

```JSON
{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "94665a90-8****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": null,
    "data": {
        "csvResult": "Table Name,Conversion Information\r\nTEST_OMSP0331.EMPLOYEES,\"[WARN] [DISCARD] CONSTRAINT \"\"FK_EMP_DEPT\"\" FOREIGN KEY (\"\"DEPT_ID\"\") REFERENCES \"\"DEPARTMENTS\"\" (\"\"DEPT_ID\"\") -> [NULL]\n\"",
        "message": null,
        "code": "FINISHED"
    }
}

```

    上一篇 下一篇 ![有帮助](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) 咨询热线