リモートクラスター情報API

構成されたリモートクラスター情報を返します。

リクエスト

GET /_remote/info

前提条件

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

説明

クラスターリモート情報APIを使用すると、構成されたすべてのリモートクラスター情報を取得できます。構成されたリモートクラスターエイリアスによってキー付けされた接続およびエンドポイント情報を返します。

レスポンスボディ

  • mode
  • リモートクラスターの接続モード。返される値はsniffとproxyです。
  • connected
  • リモートクラスターへの接続が少なくとも1つある場合はtrueです。
  • initial_connect_timeout

  • リモートクラスター接続の初期接続タイムアウト。

  • skip_unavailable
  • クロスクラスター検索中にリモートクラスターのノードが利用できない場合、クロスクラスター検索がリモートクラスターをスキップするかどうか。trueの場合、クロスクラスター検索はリモートクラスターから返されたエラーも無視します。オプションのリモートクラスターを参照してください。
  • seeds
  • スニッフモードが構成されているときのリモートクラスターの初期シードトランスポートアドレス。
  • num_nodes_connected
  • スニッフモードが構成されているときのリモートクラスター内の接続ノードの数。
  • max_connections_per_cluster
  • スニッフモードが構成されているときのリモートクラスターの最大接続数。
  • proxy_address
  • プロキシモードが構成されているときのリモート接続のアドレス。
  • num_proxy_sockets_connected
  • プロキシモードが構成されているときのリモートクラスターへのオープンソケット接続の数。
  • max_proxy_socket_connections
  • プロキシモードが構成されているときのリモートクラスターへのソケット接続の最大数。
  • cluster_credentials
  • このフィールドは、APIキーに基づくモデルでリモートクラスターが構成されている場合にのみ表示され、::es_redacted::の値を持ちます。それ以外の場合、このフィールドは存在しません。