remote-info.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. [[cluster-remote-info]]
  2. === Remote Cluster Info
  3. Returns configured remote cluster information.
  4. [[cluster-remote-info-api-request]]
  5. ==== {api-request-title}
  6. `GET /_remote/info`
  7. [[cluster-remote-info-api-desc]]
  8. ==== {api-description-title}
  9. The cluster remote info API allows you to retrieve all of the configured
  10. remote cluster information. It returns connection and endpoint information keyed
  11. by the configured remote cluster alias.
  12. [[cluster-remote-info-api-response-body]]
  13. ==== {api-response-body-title}
  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.