› › ›

API для обновления статистики последней синхронизации коннектора

Данная функциональность находится в техническом предварительном просмотре и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции в техническом предварительном просмотре не подпадают под SLA поддержки официальных функций GA.

Обновляет поля, относящиеся к последней синхронизации коннектора.

Это действие используется для аналитики и мониторинга.

Чтобы начать работу с Connector APIs, ознакомьтесь с нашим руководством.

Запрос

PUT _connector/<connector_id>/_last_sync

Предварительные условия

Для синхронизации данных с помощью собственных коннекторов, вам необходимо развернуть сервис Elastic connector на вашей собственной инфраструктуре. Этот сервис автоматически запускается на Elastic Cloud для управляемых Elastic коннекторов.
Параметр 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:

resp = client.connector.last_sync(
    connector_id="my-connector",
    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",
)
print(resp)

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

const response = await client.connector.lastSync({
  connector_id: "my-connector",
  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",
});
console.log(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"
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-last-sync-api.html