取消连接器同步作业 API

编辑

取消连接器同步作业 API编辑

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

取消连接器同步作业。

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

请求编辑

PUT _connector/_sync_job/<connector_sync_job_id>/_cancel

先决条件编辑

  • 要使用自管连接器同步数据,您需要在自己的基础架构上部署Elastic 连接器服务。此服务在 Elastic Cloud 上自动运行,用于本地连接器。
  • connector_sync_job_id 参数应引用现有的连接器同步作业。

描述编辑

取消连接器同步作业,这会将 status 设置为 cancelling,并将 cancellation_requested_at 更新为当前时间。然后,连接器服务负责将连接器同步作业的 status 设置为 cancelled

路径参数编辑

connector_sync_job_id
(必填,字符串)

响应代码编辑

200
连接器同步作业取消请求已成功提交。
404
找不到与 connector_sync_job_id 匹配的连接器同步作业。

示例编辑

以下示例取消了 ID 为 my-connector-sync-job-id 的连接器同步作业

response = client.connector.sync_job_cancel(
  connector_sync_job_id: 'my-connector-sync-job-id'
)
puts response
PUT _connector/_sync_job/my-connector-sync-job-id/_cancel