› › ›

API Forget Follower

Удаляет аренды удержания следящего индекса из лидера.

Запрос

POST /<leader_index>/_ccr/forget_follower
{
  "follower_cluster" : "<follower_cluster>",
  "follower_index" : "<follower_index>",
  "follower_index_uuid" : "<follower_index_uuid>",
  "leader_remote_cluster" : "<leader_remote_cluster>"
}

{
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "failed" : 0,
    "failures" : [ ]
  }
}

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

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

Описание

Следующий индекс использует аренды удержания на индексе-лидере. Эти аренды удержания используются для повышения вероятности того, что фрагменты индекса-лидера сохранят историю операций, которые фрагменты индекса-следящего должны выполнить для репликации. Когда индекс-следящий преобразуется в обычный индекс с помощью API unfollow (либо явным выполнением этого API, либо неявно с помощью управления жизненным циклом индекса), эти аренды удержания удаляются. Однако удаление этих аренд удержания может завершиться ошибкой (например, если удаленный кластер, содержащий индекс-лидер, недоступен). Хотя эти аренды удержания со временем истекут сами, их продлённое существование может привести к тому, что индекс-лидер будет содержать больше истории, чем необходимо, и помешать управлению жизненным циклом индексов выполнить некоторые операции с индексом-лидером. Этот API предназначен для ручного удаления этих аренд удержания в случае неудачи API unfollow.

Этот API не останавливает репликацию со стороны следящего индекса. Если вы используете этот API, нацеленный на следящий индекс, который всё ещё активно отслеживает, следящий индекс добавит обратно аренды удержания на лидер. Единственная цель этого API — обработка случаев ошибок удаления аренд удержания слежения после вызова API unfollow.

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

<leader_index>: (Обязательно, строка) Имя индекса-лидера.

Тело запроса

follower_cluster: (Обязательно, строка) Имя кластера, содержащего индекс-следящий.
follower_index: (Обязательно, строка) Имя индекса-следящего.
follower_index_uuid: (Обязательно, строка) UUID индекса-следящего.
leader_remote_cluster: (Обязательно, строка) Альяс (с точки зрения кластера, содержащего индекс-следящий) удаленного кластера, содержащего индекс-лидер.

Примеры

В этом примере удаляются аренды удержания следящего индекса для follower_index из leader_index.

POST /leader_index/_ccr/forget_follower
{
  "follower_cluster" : "follower_cluster",
  "follower_index" : "follower_index",
  "follower_index_uuid" : "vYpnaWPRQB6mNspmoCeYyA",
  "leader_remote_cluster" : "leader_cluster"
}

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

{
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "failed" : 0,
    "failures" : [ ]
  }
}

© 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/ccr-post-forget-follower.html