自動フォローパターンの取得（Get auto-follow pattern）

自動フォローパターンAPIの取得

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

リクエスト

Python

resp = client.ccr.get_auto_follow_pattern()
print(resp)

Ruby

response = client.ccr.get_auto_follow_pattern
puts response

Js

const response = await client.ccr.getAutoFollowPattern();
console.log(response);

コンソール

GET /_ccr/auto_follow/

Python

resp = client.ccr.get_auto_follow_pattern(
   name="<auto_follow_pattern_name>",
)
print(resp)

Js

const response = await client.ccr.getAutoFollowPattern({
  name: "<auto_follow_pattern_name>",
});
console.log(response);

コンソール

GET /_ccr/auto_follow/<auto_follow_pattern_name>

前提条件

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

説明

このAPIは設定された自動フォローパターンを取得します。このAPIは指定された自動フォローパターンコレクションを返します。

パスパラメータ

• <auto_follow_pattern_name>
• （オプション、文字列）取得したい自動フォローパターンコレクションを指定します。名前を指定しない場合、APIはすべてのコレクションの情報を返します。

クエリパラメータ

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

例

この例では、my_auto_follow_patternという名前の自動フォローパターンコレクションに関する情報を取得します:

Python

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

Ruby

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

Js

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

コンソール

GET /_ccr/auto_follow/my_auto_follow_pattern

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

コンソール-結果

{
  "patterns": [
   {
   "name": "my_auto_follow_pattern",
   "pattern": {
   "active": true,
   "remote_cluster" : "remote_cluster",
   "leader_index_patterns" :
   [
   "leader_index*"
   ],
   "leader_index_exclusion_patterns":
   [
   "leader_index_001"
   ],
   "follow_index_pattern" : "{{leader_index}}-follower"
   }
   }
  ]
}