remote-info.asciidoc 980 B

123456789101112131415161718192021222324252627282930313233343536
  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 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. `connected`::
  17. True if there is at least one connection to the remote cluster.
  18. `num_nodes_connected`::
  19. The number of connected nodes in the remote cluster.
  20. `max_connections_per_cluster`::
  21. The maximum number of connections maintained for the remote cluster.
  22. `initial_connect_timeout`::
  23. The initial connect timeout for remote cluster connections.
  24. `skip_unavailable`::
  25. Whether the remote cluster is skipped in case it is searched through
  26. a {ccs} request but none of its nodes are available.