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

1.5 KiB
Raw Blame History

IndicesUpdateAliasesAddAction [interface-IndicesUpdateAliasesAddAction]

Name Type Description
alias IndexAlias Alias for the action. Index alias names support date math.
aliases IndexAlias IndexAlias[]
filter QueryDslQueryContainer Query used to limit documents the alias can access.
index_routing Routing Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations. Data stream aliases don’t support this parameter.
index IndexName Data stream or index for the action. Supports wildcards ( *).
indices Indices Data streams or indices for the action. Supports wildcards ( *).
is_hidden boolean If true, the alias is hidden.
is_write_index boolean If true, sets the write index or data stream for the alias.
must_exist boolean If true, the alias must exist to perform the action.
routing Routing Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.
search_routing Routing Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations. Data stream aliases don’t support this parameter.