暂停数据同步项目 | OceanBase 文档中心

暂停数据同步项目

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

本文为您介绍 OMS 提供的 OpenAPI：暂停数据同步项目。

功能说明

本接口用于暂停数据同步项目。

接口说明

接口约束

数据同步项目必须在运行状态，才能对其执行暂停操作。
本接口适用于 OMS V2.1.2 及以上版本。

请求路径

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

请求参数

Path Parameter

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

返回结果

参数	类型	描述
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/pause' \
--header 'Authorization: Basic YWRt=' \
--header 'Content-Type: application/json'

返回示例

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