创建连接器同步作业 API

编辑

创建连接器同步作业 API

编辑

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

创建连接器同步作业。

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

resp = client.perform_request(
    "POST",
    "/_connector/_sync_job",
    headers={"Content-Type": "application/json"},
    body={
        "id": "connector-id",
        "job_type": "full",
        "trigger_method": "on_demand"
    },
)
print(resp)
response = client.connector.sync_job_post(
  body: {
    id: 'connector-id',
    job_type: 'full',
    trigger_method: 'on_demand'
  }
)
puts response
const response = await client.transport.request({
  method: "POST",
  path: "/_connector/_sync_job",
  body: {
    id: "connector-id",
    job_type: "full",
    trigger_method: "on_demand",
  },
});
console.log(response);
POST _connector/_sync_job
{
  "id": "connector-id",
  "job_type": "full",
  "trigger_method": "on_demand"
}

请求

编辑

POST _connector/_sync_job

先决条件

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

描述

编辑

在内部索引中创建连接器同步作业文档,并使用默认值初始化其计数器和时间戳。某些值可以通过 API 更新。

请求正文

编辑
id
(必需,字符串) 要为其创建同步作业的连接器的 ID。
job_type
(可选,字符串) 创建的同步作业的作业类型。默认为 full
trigger_method
(可选,字符串) 创建的同步作业的触发方法。默认为 on_demand

响应正文

编辑
id
(字符串) 与连接器同步作业文档关联的 ID。

响应代码

编辑
201
指示连接器同步作业已成功创建。
400
指示请求格式不正确。
404
指示索引或引用的连接器丢失。