› › ›

API забывания фолловера

Удаляет аренды сохранения фолловера кросс-кластерной репликации лидера.

Запрос

resp = client.ccr.forget_follower(
    index="<leader_index>",
    follower_cluster="<follower_cluster>",
    follower_index="<follower_index>",
    follower_index_uuid="<follower_index_uuid>",
    leader_remote_cluster="<leader_remote_cluster>",
)
print(resp)

const response = await client.ccr.forgetFollower({
  index: "<leader_index>",
  follower_cluster: "<follower_cluster>",
  follower_index: "<follower_index>",
  follower_index_uuid: "<follower_index_uuid>",
  leader_remote_cluster: "<leader_remote_cluster>",
});
console.log(response);

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 отключения слежения (либо явным выполнением этого API, либо неявно через управление жизненным циклом индекса), эти аренды сохранения удаляются. Однако удаление этих аренд сохранения может завершиться неудачей (например, если удаленный кластер, содержащий индекс лидера, недоступен). Хотя эти аренды сохранения со временем истекают сами по себе, их длительное существование может привести к тому, что индекс лидера будет содержать больше истории, чем необходимо, и помешать управлению жизненным циклом индекса выполнить некоторые операции с индексом лидера. Этот API предназначен для ручного удаления этих аренд сохранения в тех случаях, когда API отключения слежения не смог сделать это.

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

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

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

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

timeout: (Необязательно, время) Управляет временем ожидания результатов. По умолчанию неограничено.

Тело запроса

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

Примеры

В этом примере удаляются аренды сохранения фолловера для follower_index из leader_index.

resp = client.ccr.forget_follower(
    index="leader_index",
    follower_cluster="follower_cluster",
    follower_index="follower_index",
    follower_index_uuid="vYpnaWPRQB6mNspmoCeYyA",
    leader_remote_cluster="leader_cluster",
)
print(resp)

response = client.ccr.forget_follower(
  index: 'leader_index',
  body: {
    follower_cluster: 'follower_cluster',
    follower_index: 'follower_index',
    follower_index_uuid: 'vYpnaWPRQB6mNspmoCeYyA',
    leader_remote_cluster: 'leader_cluster'
  }
)
puts response

const response = await client.ccr.forgetFollower({
  index: "leader_index",
  follower_cluster: "follower_cluster",
  follower_index: "follower_index",
  follower_index_uuid: "vYpnaWPRQB6mNspmoCeYyA",
  leader_remote_cluster: "leader_cluster",
});
console.log(response);

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