catフィールドデータ（cat fielddata）

cat fielddata API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、nodes stats APIを使用してください。

クラスター内のすべてのデータノードで、field data cacheによって現在使用されているヒープメモリの量を返します。

Request

GET /_cat/fielddata/<field>

GET /_cat/fielddata

Prerequisites

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

Path parameters

• <field>
• （オプション、文字列）返される情報を制限するために使用されるフィールドのカンマ区切りリスト。

Query parameters

• bytes
• （オプション、バイトサイズ単位）バイト値を表示するために使用される単位。
• format
• （オプション、文字列）HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
• h
• （オプション、文字列）表示する列名のカンマ区切りリスト。
• help
• （オプション、Boolean）trueの場合、応答にはヘルプ情報が含まれます。 デフォルトはfalseです。
• s
• （オプション、文字列）応答をソートするために使用される列名または列エイリアスのカンマ区切りリスト。
• v
• （オプション、Boolean）trueの場合、応答には列見出しが含まれます。 デフォルトはfalseです。

Examples

Example with an individual field

リクエストボディまたはURLパスで個別のフィールドを指定できます。次のfieldata APIリクエストは、bodyフィールドのヒープメモリサイズ情報を取得します。

Python

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

Ruby

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

Js

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

Console

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

APIは次の応答を返します:

Txt

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

Example with a list of fields

リクエストボディまたはURLパスでカンマ区切りのフィールドリストを指定できます。次のfieldata APIリクエストは、bodyおよびsoulフィールドのヒープメモリサイズ情報を取得します。

Python

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

Ruby

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

Js

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

Console

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

APIは次の応答を返します:

Txt

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フィールドの個別のfielddataを示し、各ノードごとに1行表示されます。

Example with all fields in a cluster

次のfieldata APIリクエストは、すべてのフィールドのヒープメモリサイズ情報を取得します。

Python

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

Ruby

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

Js

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

Console

GET /_cat/fielddata?v=true

APIは次の応答を返します:

Txt

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