启动数据同步项目 | OceanBase 文档中心

启动数据同步项目

更新时间：2023-06-08 10:49:34

本文为您介绍 OMS 提供的 OpenAPI：启动 OceanBase 数据库至 Kafka 的数据同步项目。

功能说明

本接口用于启动数据同步项目。

接口说明

接口约束

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

请求路径

POST /api/omsp/v2/sync/projects/{id}/start

请求参数

Path Parameter

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

返回结果

返回 success 为 true 代表启动命令发送成功。因为启动任务涉及异步操作，您需要另外调用 OceanBase 至 Kafka 同步项目查询接口，查询同步项目的状态以确认同步项目启动成功。

参数	类型	描述
success	boolean	是否调用成功。
code	string	状态码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer[int32]	当前页数。
pageSize	integer[int32]	每页条数。
totalCount	integer[int64]	总记录数。
cost	string	请求耗时。
data	Object	对于不同的接口，本字段包含的信息不同。

示例

请求示例

curl --location --request POST 'http://xxx.xxx.xxx.1:8089/api/omsp/v2/sync/projects/sync_38twb/start' \
--header 'Authorization: Basic YWRt=' \
--header 'Content-Type: application/json' \
--data '{
    "id": "e_36iyc0h****",
    "name": "OB数据源测试",
    "dbType": "OB_MYSQL",
    "ip": "xxx.xxx.xxx.1",
    "port": 2883,
    "user": "root",
    "password": "password",
    "desc": "mysql -hxxx.xxx.xxx.1 -uroot@tenant#cluster -P2883 -ppassword -Dmysql_21",
    "region": "cn-jiangsu",
    "ocpName": "cn-anhui-212-xxx.xxx.xxx.1",
    "oceanbaseMode":"mysql",
    "cluster": "cluster",
    "tenant": "tenant",
    "domainParams": {
      "tenant": "tenant",
      "cluster": "cluster"
    }
}'

返回示例

{
  "success": true,
  "code": null,
  "message": null,
  "advice": null,
  "requestId": null,
  "pageNumber": null,
  "pageSize": null,
  "totalCount": null,
  "cost": null,
  "data": null
}