New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 检查连接器同步作业 API 设置连接器同步作业错误 API »
Elastic 文档 ›Elasticsearch 指南 [8.17] ›REST API ›连接器 API

声明连接器同步作业 API

编辑

声明连接器同步作业 API

编辑

此功能为技术预览版，未来版本可能会更改或删除。Elastic 将努力修复任何问题，但技术预览版中的功能不受正式 GA 功能的支持 SLA 的约束。

声明一个连接器同步作业。

_claim 端点不适用于用户直接管理连接器。它旨在支持利用连接器协议与 Elasticsearch 通信的服务的实现。

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

请求

编辑

PUT _connector/_sync_job/<connector_sync_job_id>/_claim

先决条件

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

描述

编辑

声明一个连接器同步作业。此操作将作业的状态更新为 in_progress，并将 last_seen 和 started_at 时间戳设置为当前时间。此外，它可以为同步作业设置 sync_cursor 属性。

路径参数

编辑
connector_sync_job_id
(必需，字符串)

请求体

编辑
worker_hostname
(必需，字符串) 将执行该作业的当前系统的主机名。
sync_cursor
(可选，对象) 上次增量同步作业的游标对象。这应引用执行作业的连接器状态中的 sync_cursor 字段。

响应代码

编辑
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/_claim",
    headers={"Content-Type": "application/json"},
    body={
        "worker_hostname": "some-machine"
    },
)
print(resp)
const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job-id/_claim",
  body: {
    worker_hostname: "some-machine",
  },
});
console.log(response);
PUT _connector/_sync_job/my-connector-sync-job-id/_claim
{
  "worker_hostname": "some-machine"
}
Copy as curlTry in Elastic 
« 检查连接器同步作业 API 设置连接器同步作业错误 API »

On this page

Was this helpful?
Feedback