› › ›

API остановки управления жизненным циклом снимков

Отключите управление жизненным циклом снимков (SLM).

Запрос

POST /_slm/stop

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

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

Описание

Останавливает все операции управления жизненным циклом снимков (SLM) и останавливает плагин SLM. Это полезно при выполнении технического обслуживания кластера и необходимо для предотвращения выполнения SLM любых действий над потоками данных или индексами. Остановка SLM не останавливает любые снимки, которые находятся в процессе выполнения. Вы можете вручную инициировать снимки с помощью API выполнения политики жизненного цикла снимков, даже если SLM остановлен.

API возвращает ответ сразу после подтверждения запроса, но плагин может продолжать работу до тех пор, пока не завершатся все операции, находящиеся в процессе выполнения, и не будет возможности безопасно его остановить.

Используйте API получения статуса управления жизненным циклом снимков, чтобы узнать, работает ли SLM.

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

master_timeout: (Необязательно, единицы измерения времени) Период ожидания узла-мастера. Если узел-мастер недоступен до истечения срока ожидания, запрос завершается ошибкой и возвращает ошибку. По умолчанию 30s. Также может быть установлено значение -1, чтобы указать, что запрос никогда не должен ожидать.
timeout: (Необязательно, единицы измерения времени) Период ожидания ответа от всех соответствующих узлов в кластере после обновления метаданных кластера. Если ответ не получен до истечения срока ожидания, обновление метаданных кластера всё равно применяется, но в ответе будет указано, что оно не было полностью подтверждено. По умолчанию 30s. Также может быть установлено значение -1, чтобы указать, что запрос никогда не должен ожидать.

Примеры

resp = client.slm.stop()
print(resp)

const response = await client.slm.stop();
console.log(response);

POST _slm/stop

© 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/slm-api-stop.html