› › ›

API получения глобальных контрольных точек

Цель API получения глобальных контрольных точек — вернуть текущие глобальные контрольные точки для индекса. Данный API позволяет пользователям узнать, какие последовательные номера были безопасно сохранены в Elasticsearch.

Ожидание продвижения глобальной контрольной точки

API имеет необязательный режим опроса, активируемый параметром запроса wait_for_advance. В режиме опроса API вернет результат только после того, как глобальные контрольные точки продвинутся за предоставленные checkpoints. По умолчанию, checkpoints является пустым массивом, что приведет к немедленному возврату API.

Если истечет время ожидания до того, как глобальные контрольные точки продвинутся за предоставленные checkpoints, Elasticsearch вернёт текущие глобальные контрольные точки и булево значение, указывающее, что запрос истек по времени.

В настоящее время параметр wait_for_advance поддерживается только для индексов с одним фрагментом.

Ожидание готовности индекса

По умолчанию в режиме опроса, будет возвращено исключение, если индекс не существует или все первичные фрагменты не активны. В режиме опроса, параметр wait_for_index может использоваться для изменения этого поведения. Если wait_for_index установлено в значение true, API будет ожидать создания индекса и активации всех первичных фрагментов.

Если время ожидания истечёт до выполнения этих условий, будет возвращено соответствующее исключение.

В настоящее время параметр wait_for_index поддерживается только когда wait_for_advance имеет значение true.

Запрос

GET /<index>/_fleet/global_checkpoints

Параметры пути

<index>: (Обязательно, строка) Единственный индекс или алиас индекса, который разрешается в один индекс.

Параметры запроса

wait_for_advance: (Необязательно, Булево) Булево значение, которое управляет ожиданием (до достижения timeout) продвижения глобальных контрольных точек за предоставленные checkpoints. По умолчанию false.
wait_for_index: (Необязательно, Булево) Булево значение, которое управляет ожиданием (до достижения timeout) существования целевого индекса и активности всех первичных фрагментов. Может быть только true, когда wait_for_advance имеет значение true. По умолчанию false.
checkpoints: (Необязательно, список) Список предыдущих глобальных контрольных точек, разделенных запятыми. При использовании в сочетании с wait_for_advance API вернёт результат только после продвижения глобальных контрольных точек за checkpoints. По умолчанию пустой список, что приведет к немедленному возврату текущих глобальных контрольных точек Elasticsearch.
timeout: (Необязательно, единицы времени) Период ожидания продвижения глобальных контрольных точек за checkpoints. По умолчанию 30s.

Тело ответа

global_checkpoints: (массив целых чисел) Глобальные контрольные точки для индекса.
timed_out: (Булево) Если false глобальные контрольные точки не продвинулись за checkpoints в указанный timeout.

© 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/7.17/get-global-checkpoints.html