› › ›

API приостановки фолловера

Приостанавливает индекс-фолловера кросс-кластерной репликации.

Запрос

resp = client.ccr.pause_follow(
    index="<follower_index>",
)
print(resp)

const response = await client.ccr.pauseFollow({
  index: "<follower_index>",
});
console.log(response);

POST /<follower_index>/_ccr/pause_follow

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

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

Описание

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

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

<follower_index>: (Обязательный, строка) Название индекса-фолловера.

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

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

Примеры

В этом примере приостанавливается индекс-фолловера с именем follower_index:

resp = client.ccr.pause_follow(
    index="follower_index",
)
print(resp)

response = client.ccr.pause_follow(
  index: 'follower_index'
)
puts response

const response = await client.ccr.pauseFollow({
  index: "follower_index",
});
console.log(response);

POST /follower_index/_ccr/pause_follow

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-post-pause-follow.html