› › ›

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