修改传输对象 | OceanBase 文档中心

修改传输对象

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

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：修改传输对象 CreateProjectModifyRecords。

功能说明

本接口用于增加或减少表对象。

调用说明

接口约束

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

请求路径

POST /api/v2?Action=CreateProjectModifyRecords

请求参数

参数	类型	描述
id	string	数据迁移、数据同步或数据校验任务的 ID。
databases	object []	数据库对象列表。具体包含的信息请参见《databases 数据结构》。

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	分片列集合。
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	分片列集合。

返回结果

参数	类型	描述
success	boolean	是否调用成功。
errorDetail	object	错误详情。
code	string	错误码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer	页序号，分页查询时生效。
pageSize	integer	页大小，分页查询时生效。
totalCount	long	总数，分页查询时生效。
cost	string	请求耗时，单位为秒。
data	long	请求返回的修改记录 ID。

示例

请求示例

{
    "id": "np_43fe****",
    "databases":[
        {
            "name":"test",
            "mappedName":"test",
            "tables":[
                    {
                        "name":"a",
                        "mappedName":"a"
                    },
                    {
                        "name":"b",
                        "mappedName":"b"
                    },
                    {
                        "name":"c",
                        "mappedName":"c"
                    }
                ]
            }
        ]
    }

返回示例

{
  "success": true,
  "errorDetail": null,
  "code": null,
  "message": null,
  "advice": null,
  "requestId": "E3D924FB-52****B253-0C1A7EFB778C",
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 100,
  "cost": "371 ms",
  "data": 24
}