Files
elasticsearch-js/docs/reference/api/IndicesExistsAliasRequest.md
2025-05-28 10:02:30 -05:00

13 lines
1.8 KiB
Markdown

# `IndicesExistsAliasRequest` [interface-IndicesExistsAliasRequest]
| Name | Type | Description |
| - | - | - |
| `allow_no_indices` | 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. |
| `body` | string | ({ [key: string]: any; } & { name?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. |
| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | 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`, `open`, `closed`, `hidden`, `none`. |
| `ignore_unavailable` | boolean | If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. |
| `index` | [Indices](./Indices.md) | Comma-separated list of data streams or indices used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. |
| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `name` | [Names](./Names.md) | Comma-separated list of aliases to check. Supports wildcards ( `*`). |
| `querystring` | { [key: string]: any; } & { name?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. |