Files
elasticsearch-js/docs/reference-indices-resolve_cluster.asciidoc
2024-12-05 14:46:51 -06:00

75 lines
4.2 KiB
Plaintext

[[reference-indices-resolve_cluster]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.indices.resolveCluster
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.
{ref}/indices-resolve-cluster-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesResolveClusterRequest, options?): Promise<IndicesResolveClusterResponse>
----
[discrete]
==== IndicesResolveClusterRequest
[pass]
++++
<pre>
++++
interface IndicesResolveClusterRequest extends <<RequestBase>> {
name: <<Names>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== IndicesResolveClusterResponse
[pass]
++++
<pre>
++++
type IndicesResolveClusterResponse = Record<<<ClusterAlias>>, IndicesResolveClusterResolveClusterInfo>
[pass]
++++
</pre>
++++