创建或更新别名
1.0 版引入
创建或更新别名 API 将一个或多个索引添加到别名中，或更新现有别名的设置。有关更多别名 API 操作，请参阅索引别名。
创建或更新别名 API 不同于别名 API，后者支持添加和删除别名以及删除别名索引。相比之下，以下 API 仅支持添加或更新别名，而不更新索引本身。每个 API 也使用不同的请求体参数。
端点
POST /<target>/_alias/<alias-name>
PUT /<target>/_alias/<alias-name>
POST /_alias/<alias-name>
PUT /_alias/<alias-name>
POST /<target>/_aliases/<alias-name>
PUT /<target>/_aliases/<alias-name>
POST /_aliases/<alias-name>
PUT /_aliases/<alias-name>
PUT /<target>/_alias
PUT /<target>/_aliases
PUT /_alias
路径参数
| 参数 | 类型 | 描述 |
|---|---|---|
目标 | 字符串 | 以逗号分隔的索引列表。支持通配符表达式 (*)。要定位集群中的所有索引，请使用 _all 或 *。可选。 |
别名名称 | 字符串 | 要创建或更新的别名名称。可选。 |
查询参数
所有查询参数都是可选的。
| 参数 | 类型 | 描述 |
|---|---|---|
cluster_manager_timeout | 时间 | 等待集群管理器节点响应的时间量。默认值为 30s。 |
timeout | 时间 | 等待集群响应的时间。默认为 30 秒。 |
请求正文
在请求体中，您可以指定索引名称、别名名称以及别名的设置。所有字段都是可选的。
| 字段 | 类型 | 描述 |
|---|---|---|
index | 字符串 | 以逗号分隔的索引列表，您希望将其与别名关联。如果设置了此字段，它将覆盖 URL 路径中指定的索引名称。 |
alias | 字符串 | 别名名称。如果设置了此字段，它将覆盖 URL 路径中指定的别名名称。 |
is_write_index | 布尔型 | 指定索引是否应为写入索引。别名一次只能有一个写入索引。如果向链接到多个索引的别名提交写入请求，OpenSearch 将仅在写入索引上运行该请求。 |
路由 | 字符串 | 为分片分配一个自定义值以用于特定操作。 |
index_routing | 字符串 | 仅为索引操作将自定义值分配给分片。 |
search_routing | 字符串 | 仅为搜索操作将自定义值分配给分片。 |
filter | 对象 | 与别名一起使用的过滤器，以便别名指向索引的过滤部分。 |
请求示例
以下示例请求添加了一个带有自定义路由值的示例别名
POST sample-index/_alias/sample-alias
{
"routing":"test"
}
示例响应
{
"acknowledged": true
}
有关更多别名 API 操作，请参阅索引别名。