フォロワー情報の取得（Get follower info）

フォロワー情報API

すべての クロスクラスタレプリケーション フォロワーインデックスに関する情報を取得します。

リクエスト

Python

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

Js

const response = await client.ccr.followInfo({
  index: "<index>",
});
console.log(response);

コンソール

GET /<index>/_ccr/info

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、monitor クラスタ権限を持っている必要があります。詳細については、セキュリティ権限を参照してください。

説明

このAPIは、各フォロワーインデックスのパラメータとステータスをリストします。たとえば、結果にはフォロワーインデックス名、リーダーインデックス名、レプリケーションオプション、およびフォロワーインデックスがアクティブか一時停止中かが含まれます。

パスパラメータ

• <index>
• （必須、文字列）フォロワーインデックスパターンのカンマ区切りリスト。

クエリパラメータ

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

レスポンスボディ

• follower_indices
• （配列）フォロワーインデックスの統計の配列。
  follower_indices のオブジェクトのプロパティ
  • follower_index
  • （文字列）フォロワーインデックスの名前。
  • leader_index
  • （文字列）フォロワークラスタでフォローされているリーダークラスタのインデックス名。
  • parameters
  • （オブジェクト）クロスクラスタレプリケーションパラメータをカプセル化するオブジェクト。フォロワーインデックスの status が paused の場合、このオブジェクトは省略されます。
    parameters のプロパティ
    • max_outstanding_read_requests
    • （長整数）リモートクラスタからの未処理の読み取りリクエストの最大数。
    • max_outstanding_write_requests
    • （整数）フォロワー上の未処理の書き込みリクエストの最大数。
    • max_read_request_operation_count
    • （整数）リモートクラスタからの読み取りごとにプルする最大操作数。
    • max_read_request_size
    • （バイト値）リモートクラスタからプルされた操作のバッチの読み取りごとの最大サイズ（バイト）。
    • max_retry_delay
    • （時間値）例外的に失敗した操作を再試行する前に待機する最大時間。再試行時には指数バックオフ戦略が採用されます。
    • max_write_buffer_count
    • （整数）書き込みのためにキューに入れられる最大操作数。この制限に達すると、リモートクラスタからの読み取りは、キューに入れられた操作の数が制限を下回るまで延期されます。
    • max_write_buffer_size
    • （バイト値）書き込みのためにキューに入れられる操作の最大合計バイト数。この制限に達すると、リモートクラスタからの読み取りは、キューに入れられた操作の合計バイト数が制限を下回るまで延期されます。
    • max_write_request_operation_count
    • （整数）フォロワー上で実行されるバルク書き込みリクエストごとの最大操作数。
    • max_write_request_size
    • （バイト値）フォロワー上で実行されるバルク書き込みリクエストごとの最大操作の合計バイト数。
    • read_poll_timeout
    • （時間値）フォロワーインデックスがリーダーインデックスと同期しているときに、リモートクラスタで新しい操作を待機する最大時間。タイムアウトが経過すると、操作のポーリングはフォロワーに戻り、いくつかの統計を更新し、その後フォロワーは再びリーダーから読み取ろうとします。
  • remote_cluster
  • （文字列）リーダーインデックスを含む リモートクラスタ。
  • status
  • （文字列）インデックスフォローが active または paused であるかどうか。

例

この例はフォロワー情報を取得します:

Python

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

Ruby

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

Js

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

コンソール

GET /follower_index/_ccr/info

フォロワーインデックスが active の場合、APIは次の結果を返します:

コンソール-結果

{
  "follower_indices": [
   {
   "follower_index": "follower_index",
   "remote_cluster": "remote_cluster",
   "leader_index": "leader_index",
   "status": "active",
   "parameters": {
   "max_read_request_operation_count": 5120,
   "max_read_request_size": "32mb",
   "max_outstanding_read_requests": 12,
   "max_write_request_operation_count": 5120,
   "max_write_request_size": "9223372036854775807b",
   "max_outstanding_write_requests": 9,
   "max_write_buffer_count": 2147483647,
   "max_write_buffer_size": "512mb",
   "max_retry_delay": "500ms",
   "read_poll_timeout": "1m"
   }
   }
  ]
}

フォロワーインデックスが paused の場合、APIは次の結果を返します:

コンソール-結果

{
  "follower_indices": [
   {
   "follower_index": "follower_index",
   "remote_cluster": "remote_cluster",
   "leader_index": "leader_index",
   "status": "paused"
   }
  ]
}