› › ›

获取索引 API

返回一个或多个索引的信息。对于数据流，API 返回关于流的后备索引的信息。

resp = client.indices.get(
    index="my-index-000001",
)
print(resp)

response = client.indices.get(
  index: 'my-index-000001'
)
puts response

const response = await client.indices.get({
  index: "my-index-000001",
});
console.log(response);

GET /my-index-000001

GET /<target>

如果启用了 Elasticsearch 安全功能，你必须对目标数据流、索引或别名拥有 view_index_metadata 或 manage 索引权限。

<target>: (必需，字符串) 用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 (*)。要针对所有数据流和索引，请省略此参数或使用 * 或 _all。

allow_no_indices

(可选，布尔值) 如果为 false，则当任何通配符表达式、索引别名或 _all 值仅针对缺失或关闭的索引时，请求将返回错误。即使请求针对其他打开的索引，此行为也适用。例如，如果索引以 foo 开头，但没有索引以 bar 开头，则针对 foo*,bar* 的请求将返回错误。

默认为 true。

expand_wildcards

(可选，字符串) 通配符模式可以匹配的索引类型。如果请求可以针对数据流，则此参数确定通配符表达式是否匹配隐藏数据流。支持逗号分隔的值，例如 open,hidden。有效值为：

默认为 open。

features

(可选，字符串) 返回有关特定索引功能的信息。支持逗号分隔的值。有效值为 aliases、mappings 和 settings。默认为 aliases,mappings,settings。

flat_settings

(可选，布尔值) 如果为 true，则以平面格式返回设置。默认为 false。

include_defaults

(可选，布尔值) 如果为 true，则在响应中返回所有默认设置。默认为 false。

ignore_unavailable

(可选，布尔值) 如果为 false，则针对缺失索引的请求将返回错误。默认为 false。

local

(可选，布尔值) 如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着信息从主节点检索。

master_timeout

(可选，时间单位) 等待主节点的时间段。如果主节点在超时到期之前不可用，则请求失败并返回错误。默认为 30s。也可以设置为 -1 以指示请求不应超时。