› › ›

cat fielddata API

编辑

cat fielddata API

编辑

cat API 仅供使用命令行或 Kibana 控制台的人员使用。它们不适用于应用程序使用。对于应用程序使用，请使用节点统计 API。

返回集群中每个数据节点上字段数据缓存当前使用的堆内存量。

请求

编辑

GET /_cat/fielddata/<field>

GET /_cat/fielddata

先决条件

编辑

如果启用了 Elasticsearch 安全功能，您必须具有 monitor 或 manage 集群权限才能使用此 API。

路径参数

编辑

<field>: (可选，字符串) 用于限制返回信息的字段的逗号分隔列表。

查询参数

编辑

bytes: (可选，字节大小单位) 用于显示字节值的单位。
format: (可选，字符串) HTTP accept header 的简短版本。有效值包括 JSON、YAML 等。
h: (可选，字符串) 要显示的列名的逗号分隔列表。
help: (可选，布尔值) 如果为 true，则响应包含帮助信息。默认为 false。
s: (可选，字符串) 用于对响应进行排序的列名或列别名的逗号分隔列表。
v: (可选，布尔值) 如果为 true，则响应包含列标题。默认为 false。

示例

编辑

单个字段的示例

编辑

您可以在请求正文或 URL 路径中指定单个字段。以下 fieldata API 请求检索 body 字段的堆内存大小信息。

resp = client.cat.fielddata(
    v=True,
    fields="body",
)
print(resp)

response = client.cat.fielddata(
  v: true,
  fields: 'body'
)
puts response

const response = await client.cat.fielddata({
  v: "true",
  fields: "body",
});
console.log(response);

GET /_cat/fielddata?v=true&fields=body

API 返回以下响应

id                     host      ip        node    field   size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body    544b

字段列表的示例

编辑

您可以在请求正文或 URL 路径中指定逗号分隔的字段列表。以下 fieldata API 请求检索 body 和 soul 字段的堆内存大小信息。

resp = client.cat.fielddata(
    fields="body,soul",
    v=True,
)
print(resp)

response = client.cat.fielddata(
  fields: 'body,soul',
  v: true
)
puts response

const response = await client.cat.fielddata({
  fields: "body,soul",
  v: "true",
});
console.log(response);

GET /_cat/fielddata/body,soul?v=true

API 返回以下响应

id                     host      ip        node    field   size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body    544b
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul    480b

响应显示 body 和 soul 字段的各个字段数据，每个节点每个字段一行。

集群中所有字段的示例

编辑

以下 fieldata API 请求检索所有字段的堆内存大小信息。

resp = client.cat.fielddata(
    v=True,
)
print(resp)

response = client.cat.fielddata(
  v: true
)
puts response

const response = await client.cat.fielddata({
  v: "true",
});
console.log(response);

GET /_cat/fielddata?v=true

API 返回以下响应

id                     host      ip        node    field   size
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body    544b
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in mind    360b
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul    480b

« cat datafeeds API cat health API »