连接器 API编辑

此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。

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

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

  • 原生连接器 是 Elastic Cloud 上的一项托管服务
  • 连接器客户端 在您的基础架构上进行自我管理

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

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

我们还为 Elastic 连接器提供了一个命令行界面。在 elastic/connectors 存储库中了解更多信息。

连接器 API编辑

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

使用以下 API 来管理连接器

  • 创建连接器 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 删除连接器 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 获取连接器 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 列出连接器 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器 API 密钥 ID [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器配置 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器过滤 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器索引名称 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器名称和描述 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器管道 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器计划 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 更新连接器服务类型 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。

同步作业 API编辑

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

使用以下 API 来管理同步作业

  • 创建连接器同步作业 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 取消连接器同步作业 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 删除连接器同步作业 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 获取连接器同步作业 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 GA 功能支持 SLA 的约束。
  • 列出连接器同步作业 [测试版] 此功能处于测试阶段,可能会发生变化。设计和代码不如正式的 GA 功能成熟,并且按原样提供,不作任何保证。测试功能不受正式 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 的约束。