解析索引
Resolve Index API 帮助您了解 OpenSearch 如何解析与指定名称或通配符表达式匹配的别名、数据流和具体索引。
端点
GET /_resolve/index/<name>
路径参数
下表列出了可用的路径参数。所有路径参数均为必需。
参数 | 数据类型 | 描述 |
---|---|---|
名称 | 字符串 | 要解析的名称、别名、数据流或通配符表达式。 |
查询参数
下表列出了可用的查询参数。所有查询参数都是可选的。
参数 | 数据类型 | 描述 |
---|---|---|
expand_wildcards | 字符串 | 控制通配符表达式如何扩展为匹配索引。多个值可以使用逗号组合。有效值包括: • all – 扩展到开放和关闭的索引,包括隐藏索引。• open – 仅扩展到开放索引。• closed – 仅扩展到关闭索引。• hidden – 包含隐藏索引(必须与 open 、closed 或两者结合使用)。• none – 不接受通配符表达式。默认: open 。 |
示例请求
以下部分提供 Resolve API 请求示例。
解析具体索引
GET _resolve/index/my-index-001
使用通配符解析索引
GET _resolve/index/my-index-*
解析数据流或别名
如果存在名为 logs-app
的别名或数据流,请使用以下请求来解析它
GET _resolve/index/logs-app
在远程集群中使用通配符解析隐藏索引
以下示例展示了一个使用通配符、远程集群并将 expand_wildcards
配置为 hidden
的 API 请求
GET _resolve/index/my-index-*,remote-cluster:my-index-*?expand_wildcards=hidden
示例响应
{
"indices": [
{
"name": "my-index-001",
"attributes": [
"open"
]
}
],
"aliases": [],
"data_streams": []
}
响应正文字段
字段 | 数据类型 | 描述 |
---|---|---|
索引 | 数组 | 已解析的具体索引列表。 |
别名 | 数组 | 已解析的索引别名列表。 |
数据流 | 数组 | 匹配的数据流列表。 |
所需权限
如果您正在使用安全插件,运行这些查询的用户需要对已解析的索引至少具有 read
权限。