フォロー解除API

クロスクラスタレプリケーションフォロワーインデックスを通常のインデックスに変換します。

リクエスト

Python

  1. resp = client.ccr.unfollow(
  2. index="<follower_index>",
  3. )
  4. print(resp)

Js

  1. const response = await client.ccr.unfollow({
  2. index: "<follower_index>",
  3. });
  4. console.log(response);

コンソール

  1. POST /<follower_index>/_ccr/unfollow
  2. ``````@
  3. ## 前提条件
  4. - Elasticsearchのセキュリティ機能が有効になっている場合、フォロワーインデックスに対して`````manage_follow_index`````インデックス権限を持っている必要があります。詳細については、[セキュリティ権限](/read/elasticsearch-8-15/bb0cb02ec6b02154.md)を参照してください。
  5. ## 説明
  6. このAPIは、フォロワーインデックスに関連するフォロータスクを停止し、クロスクラスタレプリケーションに関連するインデックスメタデータと設定を削除します。これにより、インデックスは通常のインデックスとして扱われるようになります。フォロワーインデックスは、フォロー解除APIを呼び出す前に一時停止し、閉じる必要があります。
  7. 現在、クロスクラスタレプリケーションは、既存の通常のインデックスをフォロワーインデックスに変換することをサポートしていません。フォロワーインデックスを通常のインデックスに変換することは、元に戻せない操作です。
  8. ## パスパラメータ
  9. - `````<follower_index>`````
  10. - (必須、文字列) フォロワーインデックスの名前。
  11. ## クエリパラメータ
  12. - `````master_timeout`````
  13. - (オプション、[時間単位](b10cb0563daae284.md#time-units)) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは`````30s`````です。リクエストがタイムアウトしないことを示すために`````-1`````に設定することもできます。
  14. ## 例
  15. この例では、`````follower_index`````をフォロワーインデックスから通常のインデックスに変換します:
  16. #### Python
  17. ``````python
  18. resp = client.ccr.unfollow(
  19. index="follower_index",
  20. )
  21. print(resp)

Ruby

  1. response = client.ccr.unfollow(
  2. index: 'follower_index'
  3. )
  4. puts response

Js

  1. const response = await client.ccr.unfollow({
  2. index: "follower_index",
  3. });
  4. console.log(response);

コンソール

  1. POST /follower_index/_ccr/unfollow

APIは次の結果を返します:

コンソール-結果

  1. {
  2. "acknowledged" : true
  3. }