フォロワーの一時停止（Pause follower）

フォロワーAPIの一時停止

クロスクラスタレプリケーションフォロワーインデックスを一時停止します。

リクエスト

Python

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

Js

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という名前のフォロワーインデックスを一時停止します:

Python

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

Ruby

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

Js

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

コンソール

POST /follower_index/_ccr/pause_follow

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

コンソール-結果

{
  "acknowledged" : true
}