---
title: "查询任务的修改记录 | OceanBase 文档中心"
description: 查询任务的修改记录 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：查询任务的修改记录 ListProjectModifyRecords。 功能说明 本接口用于根据数据迁移或数据同步任务的 ID 查询任务的修改记录。 调用说明 接口约…
---
切换语言

- 中文站 - 简体中文
- 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：查询任务的修改记录 ListProjectModifyRecords。

## 功能说明

本接口用于根据数据迁移或数据同步任务的 ID 查询任务的修改记录。

## 调用说明

### 接口约束

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

### 请求路径

`POST /api/v2?Action=ListProjectModifyRecords`

### 请求参数

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 数据迁移、数据同步或数据校验任务的 ID。 |

### 返回结果

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| 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 数据结构**

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 修改记录的 ID。 |
| subProjectId | string | 子任务的 ID（增加表时产生）。 |
| mergeRequestId | long | 合并父子任务的工单 ID，用于增加表的场景。 |
| updateRequestId | long | 更新父任务工单 ID，用于减表或已有表对象更新的场景。 |
| type | string | 修改记录任务类型，包括 `INCREASE_OBJECT`（增加对象）和 `DECREASE_OBJECT`（减少对象）。 |
| status | string | 修改记录的状态，包括：   - PENDING：待执行 - MODIFYING：修改中 - RUNNING：运行中（子任务运行中） - MERGING：合并中（父子任务符合合并条件） - TERMINATED：已终止 - SUCCESS：成功 - FAILED：失败 - CANCEL：已取消 |
| errorDetail | object | 错误详情。 |
| databases | object [] | 减少的对象（同步）。具体包含的信息请参见《databases 数据结构》。 |
| migrationObjectsInfo | object | 减少的对象（迁移）。具体包含的信息请参见《migrationObjectsInfo 数据结构》。 |
| omsProjectMappingInfo | object | 减少对象对应的匹配规则（迁移）。具体包含的信息请参见《omsProjectMappingInfo 数据结构》。 |
| tableEtlList | object [] | 减少对象的 ETL 信息（迁移）。具体包含的信息请参见《tableEtlList 数据结构》。 |
| gmtModified | string | 任务的更新时间，以 UTC + 0 时区的时间格式展示。 |

- **databases 数据结构**

  | 参数 | 类型 | 描述 |
  | --- | --- | --- |
  | id | string | 数据库的 ID。 |
  | name | string | 数据库的名称。 |
  | mappedName | string | 数据库的映射名称。 |
  | tables | object [] | 当前数据库中传输表对象的配置列表。`Mode` 为 `WILDCARD` 时，该参数表示具体黑名单或白名单的配置，表和视图共用。 |
  | ├─ name | string | 表的名称。 |
  | ├─ mappedName | string | 表的映射名称。 |
  | ├─ id | string | 表的 ID。 |
  | ├─ whereClause | string | 通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。 |
  | ├─ filterColumns | array | 过滤列集合。 |
  | ├─ shardColumns | array | 分片列集合。 |
  | columns | object [] | 待传输列的列表。 |
  | ├─ columnName | string | 列的名称。 |
  | ├─ mappedName | string | 列的映射名称。 |
  | ├─ position | integer | 列的位置。 |
  | ├─ columnType | string | 列的类型。 |
  | ├─ recordFieldType | string | 列类型的引申。 |
  | ├─ rawColumnType | string | 数据库记录的列类型的原始字符串。 |
  | ├─ columnKey | string | 索引的类型。 |
  | ├─ nullable | boolean | 是否可以为空。 |
  | ├─ defaultValue | string | 默认值。 |
  | ├─ dataLength | integer | 列的长度。 |
  | ├─ dataPrecision | integer | 列的精度。 |
  | ├─ dataScale | integer | 小数点。 |
  | ├─ encoding | string | 列的字符编码。 |
  | ├─ columnComment | string | 列的注释。 |
  | ├─ isGenerateField | boolean | 是否为隐藏列。 |
  | ├─ type | string | 包括 DATABASE 和 TABLE。 |
  | views | object [] | 当前数据库中传输视图对象的配置。 |
  | ├─ name | string | 视图的名称。 |
  | ├─ mappedName | string | 视图的映射名称。 |
  | ├─ id | string | 视图的 ID。 |
  | ├─ whereClause | string | 标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。 |
  | ├─ filterColumns | array | 过滤列集合。 |
  | ├─ shardColumns | array | 分片列集合。 |
  | specificTables | object [] | 具体表对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体表对象的重命名、行过滤配置。 |
  | ├─ name | string | 表的名称。 |
  | ├─ mappedName | string | 表的映射名称。 |
  | ├─ id | string | 表的 ID。 |
  | ├─ whereClause | string | 通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。 |
  | ├─ filterColumns | array | 过滤列集合。 |
  | ├─ shardColumns | array | 分片列集合。 |
  | specificViews | object [] | 具体视图对象的配置列表。`mode` 为 `WILDCARD` 时，该参数表示具体视图对象的重命名配置。 |
  | ├─ name | string | 视图的名称。 |
  | ├─ mappedName | string | 视图的映射名称。 |
  | ├─ id | string | 视图的 ID。 |
  | ├─ whereClause | string | 标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。 |
  | ├─ filterColumns | array | 过滤列集合。 |
  | ├─ shardColumns | array | 分片列集合。 |
 - **migrationObjectsInfo 数据结构**

  | 参数 | 类型 | 描述 |
  | --- | --- | --- |
  | wildcardMode | boolean | 是否为通配模式。 |
  | tables | object [] | 待迁移表的列表。 |
  | ├─ schema | string | 数据库的名称。 |
  | ├─ name | string | 待迁移表的名称。 |
  | tablesBlack | object [] | 待迁移表的黑名单列表。 |
  | ├─ schema | string | 数据库的名称。 |
  | ├─ name | string | 无需迁移的表的名称。 |
  | views | object [] | 待迁移视图的列表。 |
  | ├─ schema | string | 数据库的名称。 |
  | ├─ name | string | 待迁移视图的名称。 |
  | viewsBlack | object [] | 待迁移视图的黑名单列表。 |
  | ├─ schema | string | 数据库的名称。 |
  | ├─ name | string | 无需迁移的视图的名称。 |
 - **omsProjectMappingInfo 数据结构**

  | 参数 | 类型 | 描述 |
  | --- | --- | --- |
  | schemaMappings | object [] | Schema 映射信息列表。 |
  | ├─ sourceName | string | 源端 Schema 的名称。 |
  | ├─ destName | string | 目标端 Schema 的名称。 |
  | tableMappings | object [] | 表映射信息列表。 |
  | ├─ sourceSchema | string | 源端 Schema 的名称。 |
  | ├─ sourceName | string | 源端对象的名称。 |
  | ├─ destName | string | 目标端对象的名称。 |
  | columnMappings | object [] | 列的映射信息列表。 |
  | ├─ sourceSchema | string | 源端 Schema 的名称。 |
  | ├─ sourceTable | string | 源端表的名称。 |
  | ├─ sourceName | string | 源端对象的名称。 |
  | ├─ destName | string | 目标端对象的名称。 |
  | viewMappings | object [] | 视图的映射信息列表。 |
  | ├─ sourceSchema | string | 源端 Schema 的名称。 |
  | ├─ sourceName | string | 源端对象的名称。 |
  | ├─ destName | string | 目标端对象的名称。 |
 - **tableEtlList 数据结构**

  | 参数 | 类型 | 描述 |
  | --- | --- | --- |
  | tenantName | string | 租户的名称。 |
  | database | string | 源端数据库的名称。 |
  | destDatabase | string | 目标端数据库的名称。 |
  | tableName | string | 源端表的名称。 |
  | destName | string | 目标端表或 Topic 的名称。 |
  | whereClause | string | 通过标准的 SQL 语句中的 `WHERE` 子句，用于配置行过滤。 |
  | filterColumns | array | 过滤列集合。 |
  | shardColumns | array | 分片键列集合。 |
  | logicTableId | string | 针对逻辑表下，逻辑表的 ID。 |
  | sourceEndpointId | string | 该参数已废弃。 |

## 示例

### 请求示例

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

```

### 返回示例

```JSON
{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "94665a90-8****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "15 ms",
    "data": [
        {
            "id": 14,
            "subProjectId": "np_5****",
            "mergeRequestId": null,
            "updateRequestId": null,
            "type": "INCREASE_OBJECT",
            "status": "RUNNING",
            "errorDetail": null,
            "databases": [
                {
                    "name": "oms_test",
                    "mappedName": "mapped_test",
                    "id": null,
                    "tables": [
                        {
                            "name": "table1",
                            "mappedName": "table1",
                            "id": null,
                            "whereClause": null,
                            "filterColumns": null,
                            "shardColumns": null,
                            "columns": null,
                            "adbTableSchema": null
                        }
                    ],
                    "views": null,
                    "specificTables": null,
                    "specificViews": null
                }
            ],
            "migrationObjectsInfo": null,
            "omsProjectMappingInfo": null,
            "tableEtlList": null,
            "gmtModified": "2024-02-19T03:53:45"
        }
    ]
}

```

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