Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API кросс-кластерной репликации

API приостановки шаблона автоматического слежения

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

Для получения самых актуальных данных об API обратитесь к API кросс-кластерной репликации.

Приостанавливает шаблон автоматического слежения кросс-кластерной репликации шаблон автоматического слежения.

Запрос

POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause

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

  • Если включены функции безопасности Elasticsearch, у вас должны быть manage_ccr права доступа к кластеру в кластере, содержащем индекс последователя. Дополнительную информацию см. в разделе Права доступа к безопасности.

Описание

Этот API приостанавливает шаблон автоматического слежения. После выполнения этого API шаблон автоматического слежения становится неактивным и игнорирует любые новые индексы, созданные на удалённом кластере, соответствующие любому из шаблонов автоматического слежения. Приостановленные шаблоны автоматического слежения отображаются с полем active, установленным в значение false в API получения шаблонов автоматического слежения.

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

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

<auto_follow_pattern_name>
(Обязательный, строка) Имя шаблона автоматического слежения, который нужно приостановить.

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

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

Примеры

В этом примере приостанавливается шаблон автоматического слежения под названием my_auto_follow_pattern:

resp = client.ccr.pause_auto_follow_pattern(
    name="my_auto_follow_pattern",
)
print(resp)
response = client.ccr.pause_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response
const response = await client.ccr.pauseAutoFollowPattern({
  name: "my_auto_follow_pattern",
});
console.log(response);
POST /_ccr/auto_follow/my_auto_follow_pattern/pause

API возвращает следующий результат:

{
  "acknowledged" : true
}

© 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/ccr-pause-auto-follow-pattern.html

Spec-Zone.ru

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