创建连接器同步作业 API

编辑

创建连接器同步作业 API编辑

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

创建连接器同步作业。

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

response = client.connector.sync_job_post(
  body: {
    id: 'connector-id',
    job_type: 'full',
    trigger_method: 'on_demand'
  }
)
puts response
POST _connector/_sync_job
{
  "id": "connector-id",
  "job_type": "full",
  "trigger_method": "on_demand"
}

请求编辑

POST _connector/_sync_job

先决条件编辑

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

描述编辑

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

请求正文编辑

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

响应正文编辑

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

响应代码编辑

201
表示连接器同步作业已成功创建。
400
表示请求格式错误。
404
表示索引或引用的连接器丢失。