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

编辑

设置连接器同步作业统计信息 API编辑

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

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

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

请求编辑

PUT _connector/_sync_job/<connector_sync_job_id>/_stats

先决条件编辑

  • 要使用自管理连接器同步数据,您需要在自己的基础设施上部署Elastic 连接器服务。此服务在 Elastic Cloud 上自动运行以用于本机连接器。
  • 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 属性的时间戳。

响应代码编辑

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

示例编辑

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

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
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"
}