Resolve index API
editResolve index API
editResolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
resp = client.indices.resolve_index( name="my-index-*", ) print(resp)
response = client.indices.resolve_index( name: 'my-index-*' ) puts response
const response = await client.indices.resolveIndex({ name: "my-index-*", }); console.log(response);
GET /_resolve/index/my-index-*
Request
editGET /_resolve/index/<name>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
view_index_metadata
ormanage
index privilege for the target data stream, index, or index alias.
Path parameters
edit-
<name>
-
(Required, string) Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve, using Multi-target syntax. Resources on remote clusters can be specified using the
<cluster>:<name>
syntax.
Query parameters
edit-
expand_wildcards
-
(Optional, string) Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as
open,hidden
. Valid values are:-
all
- Match any data stream or index, including hidden ones.
-
open
- Match open, non-hidden indices. Also matches any non-hidden data stream.
-
closed
- Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
-
hidden
-
Match hidden data streams and hidden indices. Must be combined with
open
,closed
, or both. -
none
- Wildcard patterns are not accepted.
Defaults to
open
. -
-
ignore_unavailable
-
(Optional, Boolean) If
false
, the request returns an error if it targets a missing or closed index. Defaults tofalse
.Defaults to
false
. -
allow_no_indices
-
(Optional, Boolean) If
false
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.Defaults to
true
. -
ignore_throttled
-
(Optional, Boolean) If
true
, concrete, expanded or aliased indices are ignored when frozen. Defaults tofalse
.[7.16.0] Deprecated in 7.16.0.
Examples
editresp = client.indices.resolve_index( name="f*,remoteCluster1:bar*", expand_wildcards="all", ) print(resp)
response = client.indices.resolve_index( name: 'f*,remoteCluster1:bar*', expand_wildcards: 'all' ) puts response
const response = await client.indices.resolveIndex({ name: "f*,remoteCluster1:bar*", expand_wildcards: "all", }); console.log(response);
GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all
The API returns the following response:
{ "indices": [ { "name": "foo_closed", "attributes": [ "closed" ] }, { "name": "freeze-index", "aliases": [ "f-alias" ], "attributes": [ "open" ] }, { "name": "remoteCluster1:bar-01", "attributes": [ "open" ] } ], "aliases": [ { "name": "f-alias", "indices": [ "freeze-index", "my-index-000001" ] } ], "data_streams": [ { "name": "foo", "backing_indices": [ ".ds-foo-2099.03.07-000001" ], "timestamp_field": "@timestamp" } ] }