フォロワーの忘却（Forget follower）

フォロワーAPIの削除

リーダーからクロスクラスタレプリケーションフォロワー保持リースを削除します。

リクエスト

Python

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)

Js

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から削除します。

Python

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)

Ruby

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

Js

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" : [ ]
  }
}