删除连接器 API

编辑

此功能处于 Beta 阶段,可能会发生更改。其设计和代码不如正式 GA 功能成熟,按“原样”提供,不提供任何保证。Beta 功能不受正式 GA 功能的支持 SLA 约束。

删除连接器和关联的同步作业。这是一个不可恢复的破坏性操作。

注意:此操作不会删除与连接器关联的任何 API 密钥、摄取管道或数据索引。这些需要手动删除。

要开始使用连接器 API,请查看我们的教程

请求

编辑

DELETE _connector/<connector_id>

先决条件

编辑
  • 要使用自托管连接器同步数据,您需要在您自己的基础设施上部署Elastic 连接器服务。对于 Elastic 管理的连接器,此服务在 Elastic Cloud 上自动运行。
  • connector_id 参数应引用现有的连接器。

路径参数

编辑
<connector_id>
(必需,字符串)
delete_sync_jobs
(可选,布尔值)一个标志,指示是否也应删除关联的同步作业。默认为 false

响应代码

编辑
400
未提供 connector_id
404 (缺少资源)
找不到与 connector_id 匹配的连接器。

示例

编辑

以下示例删除 ID 为 my-connector 的连接器

resp = client.connector.delete(
    connector_id="another-connector",
    delete_sync_jobs=True,
)
print(resp)
const response = await client.connector.delete({
  connector_id: "another-connector",
  delete_sync_jobs: "true",
});
console.log(response);
DELETE _connector/another-connector?delete_sync_jobs=true
{
    "acknowledged": true
}

以下示例删除 ID 为 another-connector 的连接器及其关联的同步作业。