New

The executive guide to generative AI

Read more

取消连接器同步作业 API

编辑

取消连接器同步作业 API

编辑

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

取消连接器同步作业。

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

请求

编辑

PUT _connector/_sync_job/<connector_sync_job_id>/_cancel

前提条件

编辑
  • 要使用自管理连接器同步数据,您需要在您自己的基础设施上部署Elastic 连接器服务。对于 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 的连接器同步作业

resp = client.perform_request(
    "PUT",
    "/_connector/_sync_job/my-connector-sync-job-id/_cancel",
)
print(resp)
response = client.connector.sync_job_cancel(
  connector_sync_job_id: 'my-connector-sync-job-id'
)
puts response
const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job-id/_cancel",
});
console.log(response);
PUT _connector/_sync_job/my-connector-sync-job-id/_cancel
Was this helpful?
Feedback