修改数据同步对象

本文为您介绍 OMS 提供的 OpenAPI：修改数据同步对象。

功能说明

本接口用于修改数据同步对象。

接口说明

接口约束

本接口适用于 OMS V2.1.2 及以上版本。

请求路径

PUT /api/omsp/v2/sync/projects/{id}/databaseObjects

请求参数

• Path Parameter

  参数	类型	必选	描述
  id	string	Y	项目 ID。创建并保存 OceanBase 至 Kafka 同步项目接口会返回该 ID，例如 sync_2test。

• Request Body

  [
  {
      "databaseName": "string",
      "databaseId": "string",
      "mappingDatabaseName": "string",
      "tables": [
        {
          "tableName": "string",
          "tableId": "string",
          "mappingTableName": "string",
          "tableETL": {
            "tenantName": "string",
            "database": "string",
            "destDatabase": "string",
            "tableName": "string",
            "destName": "string",
            "whereClause": "string",
            "filterColumns": [
              "string"
            ],
            "shardColumns": [
              "string"
            ],
            "logicTableId": "string",
            "sourceEndpointId": "string"
          }
        }
      ]
  }
  ]
  

  参数	类型	必选	描述
  databaseName	string	Y	数据库的名称。
  databaseId	string	Y	数据库的唯一标识。
  mappingDatabaseName	string	Y	数据库的映射名称。
  tables	array	Y	需要同步的表信息。具体包含的信息请参见下面的《TableVO 数据结构》。

  TableVO 数据结构

  参数	类型	必选	描述
  tableName	string	Y	表名称。
  tableId	string	N	逻辑表的唯一标识。
  mappingTableName	string	Y	数据表的映射名称。
  tableETL	Object	Y	逻辑表过滤条件 ETL。具体包含的信息请参见下面的《OmsSyncConditionVO 数据结构》。

  OmsSyncConditionVO 数据结构

  参数	类型	必选	描述
  tenantName	string	N	租户的名称。
  database	string	N	源端数据库的名称。
  destDatabase	string	N	目标端数据库的名称。
  tableName	string	N	源端的表名称。
  destName	string	N	目标端的表称或 Topic 名称。
  whereClause	string	N	SQL 语法。
  filterColumns	array[string]	N	过滤列。
  shardColumns	array[string]	N	分片键列。
  logicTableId	string	N	逻辑表的 Table ID。
  sourceEndpointId	string	N	物理表的 EndPoint ID。

返回结果

示例

请求示例

curl --location --request PUT 'http://xxx.xxx.xxx.1:8089/api/omsp/v2/sync/projects/e_39iea***/databaseObjects' \
--header 'Authorization: Basic YWRta***=' \
--header 'Content-Type: application/json' \
--data '[
     {
      "databaseName": "databaseName",
      "tables": [
        {
          "tableName": "tableName",
          "tableETL": {}
        }
      ]
    }
]'

返回示例

{
  "success":true
  "code":"success"
  "message":"efeggccdohcivapm****"
  "advice":"cepmgjxp"
  "requestId":"C217e46E-Ef7C-6C****"
  "pageNumber":7711
  "pageSize":7563
  "totalCount":6304
  "cost":"ws***"
  "data":
  [
    0:"ofswtxjkjiwdpdidz****"
    1:"b"
  ]
}