Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve/cluster API supports no index expression #119615

Closed
wants to merge 2 commits into from

Conversation

quux00
Copy link
Contributor

@quux00 quux00 commented Jan 6, 2025

This enhancement provides users with the ability to query the _resolve/cluster API endpoint without specifying an index expression to match against. This allows users to quickly test what remote clusters are configured on a cluster and whether they are available for querying. Since the _resolve/cluster endpoint always attempts to make a remote connection on each call (unlike the _remote/info endpoint), this new endpoint provides a convenient and reliable way to check on the availability of remote clusters.

This new endpoint works with clusters from older versions.

The new endpoint takes no index expression:

GET _resolve/cluster

and returns the same information as before except for the "matching_indices" field. Example response:

{
  "remote1": {
    "connected": false,
    "skip_unavailable": true
  },
  "remote2": {
    "connected": true,
    "skip_unavailable": false,
    "version": {
      "number": "8.17.0",
      "build_flavor": "default",
      "minimum_wire_compatibility_version": "7.17.0",
      "minimum_index_compatibility_version": "7.0.0"
    }
  }
}

@quux00 quux00 added >enhancement auto-backport Automatically create backport pull requests when merged v9.0.0 v8.18.0 labels Jan 6, 2025
@quux00 quux00 force-pushed the resolve-cluster/no-index-expr branch from a300c7b to 7d42809 Compare January 6, 2025 21:42
@quux00
Copy link
Contributor Author

quux00 commented Jan 6, 2025

TODO: I need to update the resolve/cluster asciidoc end user docs, but I don't want to do that until another docs PR merges: #118993

@quux00 quux00 closed this Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant