更新 Incr-Sync 组件

更新时间：2026-04-14 15:40:47

编辑

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：更新 Incr-Sync 组件 UpdateIncrSync.

功能说明

本接口用于更新 Incr-Sync 组件。

调用说明

接口约束

本接口适用于 OMS 社区版 V4.1.1-CE 及之后版本。

请求路径

POST /api/v2?Action=UpdateIncrSync

请求参数

参数	类型	描述
dimension	string	操作维度，包括 NAME、TASK_NAME 和 IP，不能为空。
key	string	当前维度下的值，不能为空。
cmRegion	string	Incr-Sync 组件所在的地域，不能为空。
config	map	配置内容，不能为空。
├─coordinator	map	Coordinator（框架层）的配置路径为 `conf/coordinator.json`。
├─condition	map	Condition 的配置路径为 `conf/condition.json`。
├─source	map	Source Plugin 的配置路径为 `conf/source.json`，每个配置类都存在一个 config key。
├─sink	map	Sink Plugin 的配置路径为 `conf/sink.json`，每个配置类都存在一个 config key。
allowDelete	boolean	是否允许删除配置。当 `dimension` 为 `NAME` 时生效，默认值为 `false`。配置为 `true`，表示允许用户删除配置。删除配置时，接口需要传递删除后需要保留的配置。

返回结果

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

示例

请求示例

{
    "dimension":"NAME",
    "key":"xxx.xxx.xxx.1-9000:connector_v2:np_4x9j****-incr_trans-1-0:0000000006",
    "cmRegion":"cn-beijing",
    "config":{
        "coordinator":{

        },
        "condition":{

        },
        "source":{

        },
        "sink":{

        }
    }
}

返回示例

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"95b4e**a-4e***",
    "pageNumber":1,
    "pageSize":10,
    "totalCount":415,
    "cost":"36 ms",
    "data":20
}