别名
1.0 版引入
别名是一个虚拟指针,可用于引用一个或多个索引。创建和更新别名是原子操作,因此您可以在不造成任何停机的情况下重新索引数据并将别名指向它。
端点
POST _aliases
查询参数
所有参数都是可选的。
参数 | 数据类型 | 描述 |
---|---|---|
cluster_manager_timeout | 时间 | 等待来自集群管理器节点的响应时间。默认为 30s 。 |
timeout | 时间 | 等待集群响应的时间。默认为 30 秒 。 |
请求正文字段
在您的请求正文中,您需要指定要执行的操作、别名名称以及要与别名关联的索引。其他字段是可选的。
字段 | 数据类型 | 描述 | 必需 |
---|---|---|---|
actions | 数组 | 要对索引执行的操作集。有效选项包括:add 、remove 和 remove_index 。数组中必须至少有一个操作。 | 是 |
add | 不适用 | 将别名添加到指定的索引。 | 否 |
remove | 不适用 | 从指定的索引中移除别名。 | 否 |
remove_index | 不适用 | 删除索引。 | 否 |
index | 字符串 | 要与别名关联的索引名称。支持通配符表达式。 | 如果您未在正文中提供 indices 字段,则为是。 |
索引 | 数组 | 要与别名关联的索引名称数组。 | 如果您未在正文中提供 index 字段,则为是。 |
alias | 字符串 | 别名名称。 | 如果您未在正文中提供 aliases 字段,则为是。 |
aliases | 数组 | 别名名称数组。 | 如果您未在正文中提供 alias 字段,则为是。 |
filter | 对象 | 用于别名的过滤器,使别名指向索引的过滤部分。 | 否 |
is_hidden | 布尔型 | 指定别名是否应从包含通配符表达式的结果中隐藏 | 否 |
must_exist | 布尔型 | 指定要移除的别名是否必须存在。 | 否 |
is_write_index | 布尔型 | 指定索引是否应为写入索引。一个别名一次只能有一个写入索引。如果向链接到多个索引的别名提交写入请求,OpenSearch 只会在写入索引上执行该请求。 | 否 |
路由 | 字符串 | 用于为特定操作向分片分配自定义值。 | 否 |
index_routing | 字符串 | 仅用于索引操作的分片分配自定义值。 | 否 |
search_routing | 字符串 | 仅用于搜索操作的分片分配自定义值。 | 否 |
请求示例
POST _aliases
{
"actions": [
{
"add": {
"index": "movies",
"alias": "movies-alias1"
}
},
{
"remove": {
"index": "old-index",
"alias": "old-index-alias"
}
}
]
}
示例响应
{
"acknowledged": true
}
有关更多别名 API 操作,请参阅索引别名。