--- title: "更新任务配置 | OceanBase 文档中心" description: 更新任务配置 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：更新任务配置 UpdateProjectConfig。 功能说明 本接口用于更新数据迁移或数据同步任务的参数配置。 调用说明 本接口使用全量替换式更新： 全部覆盖：当您调用… --- 切换语言 - 中文站 - 简体中文 - 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：更新任务配置 UpdateProjectConfig。 ## 功能说明 本接口用于更新数据迁移或数据同步任务的参数配置。 ## 调用说明 本接口使用全量替换式更新： - 全部覆盖：当您调用本接口时，需要传入一整套完整的配置信息。 - 未传即删：在新的配置集中未包含的任务旧配置项，均将被删除。 - 差异更新：只有与系统当前记录不一致的配置项会被更新至您传入的新配置项。 ### 接口约束 本接口适用于 OMS V4.2.4 及之后版本。 ### 请求路径 `POST /api/v2?Action=UpdateProjectConfig` ### 请求参数 | 参数 | 类型 | 描述 | | --- | --- | --- | | id | string | 数据迁移、数据同步或数据校验任务的 ID。 | | commonTransferConfig | object | 通用的传输配置。 | | ├─ sinkStoreFormat | string | 目标端表对象存储类型，包括默认（DEFAULT）、行存（ROW）、列存（COLUMN）和行列混存（COMPOUND）。 | | ├─ sourceStoreFormat | string | 源端表对象存储类型，包括默认（DEFAULT）、行存（ROW）、列存（COLUMN）和行列混存（COMPOUND）。 | | structTransferConfig | object | 结构迁移的配置。 | | ├─ autoProcessedToNextStep | boolean | 结构迁移完成后是否自动进入下一个步骤，默认值为 `true`。 | | ├─ triggerMigrationType | string | 触发器迁移方式，可选值包括 `NOT_MIGRATION`（不迁移）、`WITH_STRUCT_TRANSFER`（随结构迁移）和 `WITH_TRANSFER_APP_SWITCH`（正向切换阶段迁移）。 | | fullTransferConfig | object | 全量迁移/同步的配置。 | | ├─ fullTransferSpeedMode | string | 全量迁移速度，包括 `STEADY`、`NORMAL`、`FAST` 和 `CUSTOM`。 | | ├─ fullTransferSpeedConfig | string | 全量迁移速度配置，仅在 `fullTransferSpeedMode` 为 `CUSTOM` 时生效。 | | ├─├─ memory | integer | 内存限制，单位为 GB。 | | ├─├─ readerWorkerNum | integer | 读取并发数。 | | ├─├─ writerWorkerNum | integer | 写入并发数。 | | ├─ fullVerifySpeedMode | string | 全量校验速度，包括 `STEADY`、`NORMAL`、`FAST` 和 `CUSTOM`。 | | ├─ fullVerifySpeedConfig | string | 全量校验速度配置，仅在 `fullVerifySpeedMode` 为 `CUSTOM` 时生效。 | | ├─├─ memory | integer | 内存限制，单位为 GB。 | | ├─├─ readerWorkerNum | integer | 读取并发数。 | | ├─├─ writerWorkerNum | integer | 写入并发数。 | | ├─ throttleRps | integer | 全量迁移/同步阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。 | | ├─ throttleIOPS | integer | 全量迁移/同步阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。 | | incrTransferConfig | object | 增量同步的配置。 | | ├─ startTimestamp | string | 增量同步起始位点。仅启用增量同步但未启用全量迁移时，支持设置该参数。 | | ├─ storeLogKeptHour | integer | 有增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。 | | ├─ incrLogPullSpeedMode | string | 增量日志拉取速度，可选值包括 STEADY（小）、NORMAL（中）、FAST（大）和 CUSTOM（自定义）。 | | ├─ incrLogPullSpeedConfig | object | 增量日志拉取资源配置，仅在 `incrLogPullSpeedMode` 为 `CUSTOM` 时生效。 | | ├─├─ memory | integer | 增量日志拉取的内存限制。 | | ├─ incrLogSyncSpeedMode | string | 增量数据写入速度，可选值包括 STEADY（小）、NORMAL（中）、FAST（大）和 CUSTOM（自定义）。 | | ├─ incrLogSyncSpeedConfig | object | 增量数据写入资源配置，仅在 `incrLogSyncSpeedMode` 为 `CUSTOM` 时生效。 | | ├─├─ memory | integer | 增量日志写入的内存限制。 | | ├─├─ readerWorkerNum | integer | Kafka 读取并发数。仅 Oracle 数据源作为源端，并且配置了通过 Kafka 获取增量数据时支持该参数。 | | ├─├─ writerWorkerNum | integer | 增量日志的写入并发数。 | | ├─ throttleRps | integer | 增量同步阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。 | | ├─ throttleIOPS | integer | 增量同步阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。 | | ├─ recordTypeWhiteList | array | 有增量同步阶段时，同步的增量数据类型。包括 HEARTBEAT、INSERT、UPDATE、DELETE、BEGIN、COMMIT、ROLLBACK、DDL 和 ROW。 | | ├─ supportDDLTypes | array | 支持的 DDL 类型。 - CREATE_TABLE - ALTER_TABLE - DROP_TABLE - RENAME_TABLE - TRUNCATE_TABLE - CREATE_INDEX - DROP_INDEX | | ├─ incrOnlineDdlConfig | array | 表示适配 Online DDL 工具，值可选 GH_OST、PT_OSC 和 ALIYUN_DMS，分别表示 gh-ost、pt-osc 和阿里云 DMS 工具。 - 该参数在正向增量同步配置中生效于 MySQL 数据库至 OceanBase 数据库 MySQL 兼容模式迁移的正向增量同步。 - 该参数在反向增量同步配置中生效于 OceanBase 数据库 MySQL 兼容模式至 MySQL 数据库的反向增量同步。 | | reverseIncrTransferConfig | object | 反向增量同步的配置。 | | ├─ startTimestamp | string | 反向增量同步起始位点。仅启用增量同步但未启用全量迁移时，支持设置该参数。 | | ├─ storeLogKeptHour | integer | 有反向增量同步阶段且增量日志拉取组件为 Store 时，日志的保存时间。单位为小时，默认 7 天，最长支持 365 天。 | | ├─ incrLogPullSpeedMode | string | 反向增量日志拉取速度，可选值包括 STEADY（小）、NORMAL（中）、FAST（大）和 CUSTOM（自定义）。 | | ├─ incrLogPullSpeedConfig | object | 反向增量日志拉取资源配置，仅在 `incrLogPullSpeedMode` 为 `CUSTOM` 时生效。 | | ├─├─ memory | integer | 反向增量日志拉取的内存限制。 | | ├─ incrLogSyncSpeedMode | string | 反向增量数据写入速度，可选值包括 STEADY（小）、NORMAL（中）、FAST（大）和 CUSTOM（自定义）。 | | ├─ incrLogSyncSpeedConfig | object | 反向增量数据写入资源配置，仅在 `incrLogSyncSpeedMode` 为 `CUSTOM` 时生效。 | | ├─├─ memory | integer | 反向增量日志写入的内存限制。 | | ├─├─ readerWorkerNum | integer | Kafka 读取并发数。仅 Oracle 数据源作为目标端，并且配置了通过 Kafka 获取增量数据时支持该参数。 | | ├─├─ writerWorkerNum | integer | 反向增量日志的写入并发数。 | | ├─ throttleRps | integer | 反向增量同步阶段限制能达到的最大传输速率，单位为记录数/秒。输入 null 时，表示不限制 RPS。 | | ├─ throttleIOPS | integer | 反向增量同步阶段限制能达到的最大传输流量，单位为字节/秒。输入 null 时，表示不限制 IOPS。 | | ├─ recordTypeWhiteList | array | 有反向增量同步阶段时，同步的增量数据类型。包括 HEARTBEAT、INSERT、UPDATE、DELETE、BEGIN、COMMIT、ROLLBACK、DDL 和 ROW。 | | ├─ supportDDLTypes | array | 支持的 DDL 类型。 - CREATE_TABLE - ALTER_TABLE - DROP_TABLE - RENAME_TABLE - TRUNCATE_TABLE - CREATE_INDEX - DROP_INDEX | | ├─ incrOnlineDdlConfig | array | 表示适配 Online DDL 工具，值可选 GH_OST、PT_OSC 和 ALIYUN_DMS，分别表示 gh-ost、pt-osc 和阿里云 DMS 工具。 - 该参数在正向增量同步配置中生效于 MySQL 数据库至 OceanBase 数据库 MySQL 兼容模式迁移的正向增量同步。 - 该参数在反向增量同步配置中生效于 OceanBase 数据库 MySQL 兼容模式至 MySQL 数据库的反向增量同步。 | ### 返回参数 | 参数 | 类型 | 描述 | | --- | --- | --- | | success | boolean | 是否调用成功。 | | errorDetail | object | 错误详情。 | | code | string | 错误码。 | | message | string | 描述信息。 | | advice | string | 建议。 | | requestId | string | 请求 ID。 | | pageNumber | integer[int32] | 页序号，分页查询时生效。 | | pageSize | integer[int32] | 页大小，分页查询时生效。 | | totalCount | integer[int64] | 总数，分页查询时生效。 | | cost | string | 请求耗时，单位为秒。 | ## 示例 ### 请求示例 ```JSON { "id":"np_4w3a****", "commonTransferConfig":{ "sinkStoreFormat":"DEFAULT", "sourceStoreFormat":"DEFAULT" }, "structTransferConfig":{ "autoProcessedToNextStep": true, "triggerMigrationType":"NOT_MIGRATION" }, "fullTransferConfig":{ "fullTransferSpeedMode":"CUSTOM", "fullTransferSpeedConfig":{ "memory":4, "readerWorkerNum":1, "writerWorkerNum":2 }, "fullVerifySpeedMode":"CUSTOM", "fullVerifySpeedConfig":{ "memory":4, "readerWorkerNum":1, "writerWorkerNum":2 }, "throttleRps": 1000, "throttleIOPS": 1000 }, "incrTransferConfig":{ "startTimestamp":1689201369, "storeLogKeptHour":168, "incrLogPullSpeedMode":"NORMAL", "incrLogPullSpeedConfig":{ "memory":4 }, "incrLogSyncSpeedMode":"CUSTOM", "incrLogSyncSpeedConfig":{ "memory":4, "readerWorkerNum":1, "writerWorkerNum":2 }, "throttleRps": 1000, "throttleIOPS": 1000, "recordTypeWhiteList":[ "DELETE", "INSERT", "UPDATE", "DDL", ], "supportDDLTypes":[ "CREATE_TABLE", "ALTER_TABLE" ], "incrOnlineDdlConfig":[ "ALIYUN_DMS" ] } "ReverseIncrTransferConfig":{ "startTimestamp":1689201369, "recordTypeWhiteList":[ "DELETE", "INSERT", "UPDATE" ], "storeLogKeptHour":120, "incrSyncConcurrency":64, "incrLogPullSpeedMode":"NORMAL", "incrLogPullSpeedConfig":{ "memory":4 }, "incrLogSyncSpeedMode":"CUSTOM", "incrLogSyncSpeedConfig":{ "memory":4, "readerWorkerNum":1, "writerWorkerNum":2 }, "throttleRps": 1000, "throttleIOPS": 1000, "enableIncrSyncStatistics":true, "supportDDLTypes":[ "CREATE_TABLE", "ALTER_TABLE" ] } } ``` ### 返回示例 ```JSON { "Success":true, "ErrorDetail":{ "Code":"CM-RES***11", "Level":"WARN", "Message":"A system error occurred.", "Proposal":"Contact the administrator." }, "Code":"INNER_ERROR", "Message":"A system error occurred.", "Advice":"Contact the administrator.", "RequestId":"XCVSADG****DSGDS", "PageNumber":1, "PageSize":1, "TotalCount":1, "Cost":"27 ms" } ``` 上一篇 下一篇 ![有帮助](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) 咨询热线