remote-info.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. [[cluster-remote-info]]
  2. == Remote Cluster Info
  3. The cluster remote info API allows to retrieve all of the configured
  4. remote cluster information.
  5. [source,js]
  6. ----------------------------------
  7. GET /_remote/info
  8. ----------------------------------
  9. // CONSOLE
  10. This command returns returns connection and endpoint information keyed by
  11. the configured remote cluster alias.
  12. [float]
  13. [[connection-info]]
  14. `seeds`::
  15. The configured initial seed transport addresses of the remote cluster.
  16. `http_addresses`::
  17. The published http addresses of all connected remote nodes.
  18. `connected`::
  19. True if there is at least one connection to the remote cluster.
  20. `num_nodes_connected`::
  21. The number of connected nodes in the remote cluster.
  22. `max_connection_per_cluster`::
  23. The maximum number of connections maintained for the remote cluster.
  24. `initial_connect_timeout`::
  25. The initial connect timeout for remote cluster connections.
  26. `skip_unavailable`::
  27. Whether the remote cluster is skipped in case it is searched through
  28. a cross cluster search request but none of its nodes are available.