删除数据同步项目 | OceanBase 文档中心

删除数据同步项目

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

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

功能说明

本接口用于删除数据同步项目。

接口说明

接口约束

数据同步项目必须处于 初始化 或者 已释放 状态，才能对其执行删除操作。
本接口适用于 OMS V2.1.2 及以上版本。

请求路径

DELETE /api/omsp/v2/sync/projects/{id}

请求参数

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 DELETE 'http://xxx.xxx.xxx.1:8089/api/omsp/v2/sync/projects/sync_38u2***' \
--header 'Authorization: Basic YWRt***='

返回示例

{
  "success": true,
  "code": "success",
  "message": "mdieqqbbdrnlvprr***",
  "advice": "xu",
  "requestId": "bCf6fABF-Cc48-9397-c716-E7A***",
  "pageNumber": 2596,
  "pageSize": 9620,
  "totalCount": 8741,
  "cost": "xhfjptfvijdf***",
  "data": true
}