列出连接器同步作业 API

编辑

此功能处于测试阶段,可能随时更改。其设计和代码不如正式 GA 功能成熟,按原样提供,不提供任何担保。测试版功能不受正式 GA 功能的支持服务等级协议 (SLA) 的约束。

返回有关所有已存储连接器同步作业的信息,按其创建时间升序排列。

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

请求

编辑

GET _connector/_sync_job

先决条件

编辑
  • 要使用自管理连接器同步数据,您需要在自己的基础设施上部署Elastic 连接器服务。对于 Elastic 托管连接器,此服务在 Elastic Cloud 上自动运行。

路径参数

编辑
size
(可选,整数) 要检索的最大结果数。默认为100
from
(可选,整数) 从第一个结果开始获取的偏移量。默认为0
status
(可选,作业状态) 用于过滤结果的作业状态。可用的状态包括:cancelingcanceledcompletederrorin_progresspendingsuspended
connector_id
(可选,字符串) 获取的同步作业需要具有的连接器 ID。
job_type
(可选,作业类型) 作业类型的逗号分隔列表。可用的作业类型为:fullincrementalaccess_control

示例

编辑

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

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
)
print(resp)
response = client.connector.sync_job_list
puts response
const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
});
console.log(response);
GET _connector/_sync_job

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

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "from": "0",
        "size": "2"
    },
)
print(resp)
response = client.connector.sync_job_list(
  from: 0,
  size: 2
)
puts response
const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    from: "0",
    size: "2",
  },
});
console.log(response);
GET _connector/_sync_job?from=0&size=2

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

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "status": "pending"
    },
)
print(resp)
response = client.connector.sync_job_list(
  status: 'pending'
)
puts response
const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    status: "pending",
  },
});
console.log(response);
GET _connector/_sync_job?status=pending

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

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "connector_id": "connector-1"
    },
)
print(resp)
response = client.connector.sync_job_list(
  connector_id: 'connector-1'
)
puts response
const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    connector_id: "connector-1",
  },
});
console.log(response);
GET _connector/_sync_job?connector_id=connector-1

以下示例列出作业类型为fullincremental的连接器同步作业(默认情况下前 100 个)

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "job_type": "full,incremental"
    },
)
print(resp)
response = client.connector.sync_job_list(
  job_type: 'full,incremental'
)
puts response
const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    job_type: "full,incremental",
  },
});
console.log(response);
GET _connector/_sync_job?job_type=full,incremental

响应代码

编辑

200:表示已成功返回结果(结果也可能为空)。

400:表示请求格式错误。