列出连接器同步作业 API
编辑列出连接器同步作业 API
编辑此功能处于 Beta 测试阶段,可能会发生更改。其设计和代码不如正式 GA 功能成熟,按原样提供,不提供任何保证。Beta 功能不受正式 GA 功能的支持 SLA 约束。
返回有关所有存储的连接器同步作业的信息,并按其创建日期升序排序。
要开始使用连接器 API,请查看我们的教程。
请求
编辑GET _connector/_sync_job
先决条件
编辑- 要使用自管理连接器同步数据,您需要在您自己的基础设施上部署Elastic 连接器服务。此服务在 Elastic Cloud 上为 Elastic 管理的连接器自动运行。
路径参数
编辑-
size
- (可选,整数)要检索的最大结果数。默认为
100
。 -
from
- (可选,整数)从第一个结果开始要获取的偏移量。默认为
0
。 -
status
- (可选,作业状态)用于筛选结果的作业状态。可用的状态包括:
canceling
、canceled
、completed
、error
、in_progress
、pending
、suspended
。 -
connector_id
- (可选,字符串)所获取的同步作业需要具有的连接器 ID。
-
job_type
- (可选,作业类型)以逗号分隔的作业类型列表。可用的作业类型有:
full
、incremental
和access_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
以下示例列出作业类型为 full
或 incremental
的连接器的连接器同步作业(默认情况下,前 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