自動フォローパターンの一時停止（Pause auto-follow pattern）

自動フォローパターンAPIの一時停止

クロスクラスター複製の自動フォローパターンを一時停止します。

リクエスト

POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、フォロワーインデックスを含むクラスターに対してmanage_ccrクラスター権限を持っている必要があります。詳細については、セキュリティ権限を参照してください。

説明

このAPIは自動フォローパターンを一時停止します。このAPIが返されると、自動フォローパターンは非アクティブになり、リモートクラスターで作成された新しいインデックスを無視します。これは自動フォローのパターンに一致します。一時停止された自動フォローパターンは、GET自動フォローパターンAPIでactiveフィールドがfalseに設定されている状態で表示されます。

自動フォローパターンの再開APIを使用して自動フォローを再開できます。一度再開されると、自動フォローパターンは再びアクティブになり、リモートクラスターで作成された新しいインデックスに対してフォロワーインデックスを自動的に構成します。パターンが一時停止している間に作成されたリモートインデックスもフォローされますが、その間に削除または閉じられていない限りです。

パスパラメータ

• <auto_follow_pattern_name>
• （必須、文字列）一時停止する自動フォローパターンの名前。

クエリパラメータ

• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

例

この例では、my_auto_follow_patternという名前の自動フォローパターンを一時停止します:

Python

resp = client.ccr.pause_auto_follow_pattern(
   name="my_auto_follow_pattern",
)
print(resp)

Ruby

response = client.ccr.pause_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response

Js

const response = await client.ccr.pauseAutoFollowPattern({
  name: "my_auto_follow_pattern",
});
console.log(response);

コンソール

POST /_ccr/auto_follow/my_auto_follow_pattern/pause

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

コンソール-結果

{
  "acknowledged" : true
}