更新连接器最后同步统计信息 API

编辑

更新连接器最后同步统计信息 API编辑

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

更新与连接器最后一次同步相关的字段。

此操作用于分析和监控。

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

请求编辑

PUT _connector/<connector_id>/_last_sync

先决条件编辑

  • 要使用自管连接器同步数据,您需要在自己的基础架构上部署Elastic 连接器服务。此服务在 Elastic Cloud 上自动运行,用于原生连接器。
  • connector_id参数应引用现有的连接器。

路径参数编辑

<connector_id>
(必填,字符串)

请求正文编辑

last_access_control_sync_error
(可选,字符串)与访问控制同步相关的最后一个错误消息(如果有)。
last_access_control_sync_scheduled_at
(可选,日期时间)指示上次访问控制同步计划时间的日期时间。
last_access_control_sync_status
(可选,ConnectorSyncStatus)上次访问控制同步的状态。
last_deleted_document_count
(可选,长整型)在上一次同步过程中删除的文档数。
last_incremental_sync_scheduled_at
(可选,日期时间)上次增量同步计划的日期时间。
last_indexed_document_count
(可选,长整型)上次同步中索引的文档数。
last_sync_error
(可选,字符串)同步过程中遇到的最后一个错误消息(如果有)。
last_sync_scheduled_at
(可选,日期时间)上次同步计划的日期时间。
last_sync_status
(可选,ConnectorSyncStatus)上次同步的状态。
last_synced
(可选,日期时间)上次成功同步的日期时间。

ConnectorSyncStatus的值是以下表示不同同步状态的小写字符串之一

  • canceling:同步过程正在取消中。
  • canceled:同步过程已被取消。
  • completed:同步过程已成功完成。
  • error:同步过程中发生错误。
  • in_progress:同步过程当前正在进行中。
  • pending:同步正在等待中,尚未开始。
  • suspended:同步过程已暂时挂起。

响应代码编辑

200
连接器最后同步统计信息已成功更新。
400
未提供connector_id或请求有效负载格式错误。
404(缺少资源)
找不到与connector_id匹配的连接器。

示例编辑

以下示例更新 ID 为my-connector的连接器的最后同步统计信息

response = client.connector.last_sync(
  connector_id: 'my-connector',
  body: {
    last_access_control_sync_error: 'Houston, we have a problem!',
    last_access_control_sync_scheduled_at: '2023-11-09T15:13:08.231Z',
    last_access_control_sync_status: 'pending',
    last_deleted_document_count: 42,
    last_incremental_sync_scheduled_at: '2023-11-09T15:13:08.231Z',
    last_indexed_document_count: 42,
    last_sync_error: 'Houston, we have a problem!',
    last_sync_scheduled_at: '2024-11-09T15:13:08.231Z',
    last_sync_status: 'completed',
    last_synced: '2024-11-09T15:13:08.231Z'
  }
)
puts response
PUT _connector/my-connector/_last_sync
{
    "last_access_control_sync_error": "Houston, we have a problem!",
    "last_access_control_sync_scheduled_at": "2023-11-09T15:13:08.231Z",
    "last_access_control_sync_status": "pending",
    "last_deleted_document_count": 42,
    "last_incremental_sync_scheduled_at": "2023-11-09T15:13:08.231Z",
    "last_indexed_document_count": 42,
    "last_sync_error": "Houston, we have a problem!",
    "last_sync_scheduled_at": "2024-11-09T15:13:08.231Z",
    "last_sync_status": "completed",
    "last_synced": "2024-11-09T15:13:08.231Z"
}
{
    "result": "updated"
}