3.2 KiB
3.2 KiB
IndicesResolveClusterRequest [interface-IndicesResolveClusterRequest]
| 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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
body |
string | ({ [key: string]: any; } & { name?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; timeout?: never; }) |
expand_wildcards |
ExpandWildcards | 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. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
ignore_throttled |
boolean | If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
ignore_unavailable |
boolean | If false, the request returns an error if it targets a missing or closed index. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression. |
name |
Names | A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>: <name> syntax. Index and cluster exclusions (e.g., -cluster1:*) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching |
querystring |
{ [key: string]: any; } & { name?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; timeout?: never; } | All values in querystring will be added to the request querystring. |
timeout |
Duration | The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds). |