› › ›

列出连接器同步作业 API

列出连接器同步作业 API编辑

此功能处于测试阶段，可能会发生变化。设计和代码比正式 GA 功能成熟度低，按原样提供，不提供任何担保。测试版功能不受正式 GA 功能支持 SLA 的约束。

返回有关所有存储的连接器同步作业的信息，按其创建日期升序排序。

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

GET _connector/_sync_job

size: (可选，整数) 要检索的最大结果数。默认为 100。
from: (可选，整数) 从第一个结果开始获取的偏移量。默认为 0。
status: (可选，作业状态) 用于过滤结果的作业状态的逗号分隔列表。可用状态包括：canceling、canceled、completed、error、in_progress、pending、suspended。
connector_id: (可选，字符串) 获取的同步作业需要具有的连接器 ID。
job_type: (可选，作业类型) 作业类型的逗号分隔列表。可用的作业类型是：full、incremental 和 access_control。

以下示例列出所有连接器同步作业

response = client.connector.sync_job_list
puts response

GET _connector/_sync_job

以下示例列出前两个连接器同步作业

response = client.connector.sync_job_list(
  from: 0,
  size: 2
)
puts response

GET _connector/_sync_job?from=0&size=2

以下示例列出挂起的连接器同步作业（默认情况下前 100 个）

response = client.connector.sync_job_list(
  status: 'pending'
)
puts response

GET _connector/_sync_job?status=pending

以下示例列出连接器 ID 为 connector-1 的连接器同步作业（默认情况下前 100 个）

response = client.connector.sync_job_list(
  connector_id: 'connector-1'
)
puts response

GET _connector/_sync_job?connector_id=connector-1

以下示例列出作业类型为 full 或 incremental 的连接器同步作业（默认情况下前 100 个）

GET _connector/_sync_job?job_type=full,incremental

200：表示已成功返回结果（结果也可能为空）。

400：表示请求格式错误。