自動フォローパターンAPIの削除

クロスクラスター複製の自動フォローパターンを削除します。

リクエスト

Python

  1. resp = client.ccr.delete_auto_follow_pattern(
  2. name="<auto_follow_pattern_name>",
  3. )
  4. print(resp)

Js

  1. const response = await client.ccr.deleteAutoFollowPattern({
  2. name: "<auto_follow_pattern_name>",
  3. });
  4. console.log(response);

コンソール

  1. DELETE /_ccr/auto_follow/<auto_follow_pattern_name>

前提条件

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

説明

このAPIは、構成された自動フォローパターンのコレクションを削除します。

パスパラメータ

  • <auto_follow_pattern_name>
  • (必須、文字列)削除する自動フォローパターンコレクションを指定します。

クエリパラメータ

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

この例では、my_auto_follow_patternという名前の自動フォローパターンコレクションを削除します:

Python

  1. resp = client.ccr.delete_auto_follow_pattern(
  2. name="my_auto_follow_pattern",
  3. )
  4. print(resp)

Ruby

  1. response = client.ccr.delete_auto_follow_pattern(
  2. name: 'my_auto_follow_pattern'
  3. )
  4. puts response

Js

  1. const response = await client.ccr.deleteAutoFollowPattern({
  2. name: "my_auto_follow_pattern",
  3. });
  4. console.log(response);

コンソール

  1. DELETE /_ccr/auto_follow/my_auto_follow_pattern

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

コンソール-結果

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