Link Search Menu Expand Document Documentation Menu
文档

获取索引

1.0 版引入

您可以使用获取索引 API 操作来返回有关索引的信息。

端点

GET /<index>

路径参数

路径参数

下表列出了可用的路径参数。所有路径参数均为可选。

参数 数据类型 描述
<索引> 字符串 应用操作的索引、数据流或索引别名的逗号分隔列表。支持通配符表达式 (*)。使用 _all 或 * 指定集群中的所有索引和数据流。

查询参数

所有参数都是可选的。

参数 类型 描述
allow_no_indices 布尔型 是否忽略不匹配任何索引的通配符。默认值为 true。
expand_wildcards 字符串 将通配符表达式扩展到不同的索引。使用逗号组合多个值。可用值包括 all（匹配所有索引）、open（匹配开放索引）、closed（匹配关闭索引）、hidden（匹配隐藏索引）和 none（不接受通配符表达式），none 必须与 open、closed 或两者结合使用。默认值为 open。
flat_settings 布尔型 是否以扁平形式返回设置，这可以提高可读性，特别是对于深度嵌套的设置。例如，“index”: { “creation_date”: “123456789” } 的扁平形式是 “index.creation_date”: “123456789”。
include_defaults 布尔型 是否在响应中包含默认设置。此参数对于识别您要更新的设置名称和当前值非常有用。
ignore_unavailable 布尔型 如果为 true，OpenSearch 不会在响应中包含缺失或关闭的索引。
local 布尔型 是否仅从本地节点而不是从集群管理器节点返回信息。默认值为 false。
cluster_manager_timeout 时间 等待连接到集群管理器节点的时间。默认值为 30s。

请求示例

GET /sample-index

示例响应

{
  "sample-index1": {
    "aliases": {},
    "mappings": {},
    "settings": {
      "index": {
        "creation_date": "1633044652108",
        "number_of_shards": "2",
        "number_of_replicas": "1",
        "uuid": "XcXA0aZ5S0aiqx3i1Ce95w",
        "version": {
          "created": "135217827"
        },
        "provided_name": "sample-index1"
      }
    }
  }
}

响应正文字段

字段 描述
别名 与索引关联的任何别名。
映射 索引中的任何映射。
设置 索引的设置
创建日期 索引创建时的 Unix 纪元时间。
分片数量 索引拥有的分片数量。
副本数量 索引拥有的副本数量。
uuid 索引的 UUID。
创建时间 创建索引时 OpenSearch 的版本。
provided_name 索引的名称。
剩余 350 字符

有问题？。

想贡献？ 或 。