连接器 API

编辑

此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。

连接器和同步作业 API 提供了一种方便的方法,用于在内部索引中创建和管理 Elastic 连接器和同步作业。要开始使用连接器 API,请查看我们的教程

连接器是 Elasticsearch 集成,可从第三方数据源引入内容,这些内容可以部署在 Elastic Cloud 上或托管在你自己的基础设施上

  • 托管连接器是 Elastic Cloud 上的托管服务
  • 自托管连接器是自托管在你自己的基础设施上的

连接器文档中查找所有受支持服务类型的列表。

此 API 提供了一种替代方案,可避免仅依赖 Kibana UI 进行连接器和同步作业管理。该 API 附带一组验证和断言,以确保内部索引中的状态表示保持有效。

我们还有一个用于 Elastic 连接器的命令行界面。请在 elastic/connectors 存储库中了解更多信息。

连接器 API

编辑

你可以使用这些 API 来创建、获取、删除和更新连接器。

使用以下 API 管理连接器

  • 创建连接器 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 删除连接器 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 获取连接器 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 列出连接器 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器 API 密钥 ID [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器配置 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器功能 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器筛选 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器索引名称 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器名称和描述 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器管道 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器计划 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器服务类型 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。

同步作业 API

编辑

你可以使用这些 API 来创建、取消、删除和更新同步作业。

使用以下 API 管理同步作业

  • 创建连接器同步作业 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 取消连接器同步作业 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 删除连接器同步作业 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 获取连接器同步作业 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。
  • 列出连接器同步作业 [beta] 此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按“现状”提供,不提供任何保证。Beta 测试版功能不受官方 GA 功能的支持 SLA 约束。

服务 API

编辑

此功能处于技术预览阶段,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版的功能不受官方 GA 功能的支持 SLA 约束。

连接器服务 API是连接器 API 端点的子集,表示在 连接器协议 中定义的框架级操作。这些 API 不供用户直接管理连接器,而是用于支持利用连接器协议与 Elasticsearch 通信的服务的实现。

所有 Elastic 连接器均使用我们的 Python 连接器框架构建。源代码可在 GitHub 上的 elastic/connectors 存储库中找到。

连接器服务 API

编辑
  • 签入连接器 [预览] 此功能处于技术预览阶段,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版的功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器错误 [预览] 此功能处于技术预览阶段,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版的功能不受官方 GA 功能的支持 SLA 约束。
  • 更新连接器上次同步统计信息 [预览版] 此功能为技术预览版,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。
  • 更新连接器状态 [预览版] 此功能为技术预览版,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。

同步作业服务 API

编辑
  • 签入连接器同步作业 [预览版] 此功能为技术预览版,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。
  • 声明连接器同步作业 [预览版] 此功能为技术预览版,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。
  • 设置连接器同步作业错误 [预览版] 此功能为技术预览版,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。
  • 设置连接器同步作业统计信息 [预览版] 此功能为技术预览版,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。