设置连接器同步作业统计 API

编辑

设置连接器同步作业统计 API

编辑

此功能处于技术预览阶段,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版的功能不受官方 GA 功能的支持 SLA 约束。

设置连接器同步作业的统计信息。

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

请求

编辑

PUT _connector/_sync_job/<connector_sync_job_id>/_stats

先决条件

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

描述

编辑

设置连接器同步作业的统计信息。统计信息包括:deleted_document_countindexed_document_countindexed_document_volumetotal_document_countlast_seen 也可以使用此 API 更新。此 API 主要由连接器服务用于更新同步作业信息。

路径参数

编辑
<connector_sync_job_id>
(必需,字符串)

请求主体

编辑
deleted_document_count
(必需,整数)同步作业删除的文档数。
indexed_document_count
(必需,整数)同步作业索引的文档数。
indexed_document_volume
(必需,整数)同步作业索引的数据总大小(以 MiB 为单位)。
total_document_count
(可选,整数)同步作业完成后目标索引中的文档总数。
last_seen
(可选,即时)设置连接器同步作业的 last_seen 属性的时间戳。
metadata
(可选,对象)连接器特定的元数据。

响应代码

编辑
200
表示连接器同步作业统计信息已成功更新。
404
找不到与 connector_sync_job_id 匹配的连接器同步作业。

示例

编辑

以下示例为连接器同步作业 my-connector-sync-job 设置所有必需的和可选的统计信息

resp = client.perform_request(
    "PUT",
    "/_connector/_sync_job/my-connector-sync-job/_stats",
    headers={"Content-Type": "application/json"},
    body={
        "deleted_document_count": 10,
        "indexed_document_count": 20,
        "indexed_document_volume": 1000,
        "total_document_count": 2000,
        "last_seen": "2023-01-02T10:00:00Z"
    },
)
print(resp)
response = client.connector.sync_job_update_stats(
  connector_sync_job_id: 'my-connector-sync-job',
  body: {
    deleted_document_count: 10,
    indexed_document_count: 20,
    indexed_document_volume: 1000,
    total_document_count: 2000,
    last_seen: '2023-01-02T10:00:00Z'
  }
)
puts response
const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job/_stats",
  body: {
    deleted_document_count: 10,
    indexed_document_count: 20,
    indexed_document_volume: 1000,
    total_document_count: 2000,
    last_seen: "2023-01-02T10:00:00Z",
  },
});
console.log(response);
PUT _connector/_sync_job/my-connector-sync-job/_stats
{
    "deleted_document_count": 10,
    "indexed_document_count": 20,
    "indexed_document_volume": 1000,
    "total_document_count": 2000,
    "last_seen": "2023-01-02T10:00:00Z"
}