Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›Connector API

API для установки статистики задач синхронизации коннектора

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

Справочник по новым API

Для получения самой актуальной информации об API, обратитесь к Connector API.

Устанавливает статистику задач синхронизации коннектора.

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

Запрос

PUT _connector/_sync_job/<connector_sync_job_id>/_stats

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

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

Описание

Устанавливает статистику для задачи синхронизации коннектора. Статистика включает: deleted_document_count, indexed_document_count, indexed_document_volume и total_document_count. last_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"
}

© 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/set-connector-sync-job-stats-api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API