cat indices API

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

クラスター内のインデックスに関する高レベルの情報を返します。これには、データストリームのバックインデックスが含まれます。

Request

GET /_cat/indices/<target>

GET /_cat/indices

Prerequisites

  • Elasticsearch のセキュリティ機能が有効になっている場合、この API を使用するには monitor または manage クラスター権限 が必要です。また、取得するデータストリーム、インデックス、またはエイリアスに対して monitor または manage インデックス権限 も必要です。

Description

cat indices API を使用して、クラスター内の各インデックスに関する以下の情報を取得します：

  • シャード数
  • ドキュメント数
  • 削除されたドキュメント数
  • プライマリストレージサイズ
  • シャードレプリカを含むすべてのシャードの合計ストレージサイズ

これらのメトリックは、Elasticsearch が内部でインデックス作成と検索を実行するために使用する Lucene から直接取得されます。そのため、すべてのドキュメント数には隠れた nested ドキュメントが含まれます。

Elasticsearch ドキュメントの正確なカウントを取得するには、cat count または count API を使用してください。

Path parameters

  • <target>
  • (オプション、文字列) リクエストを制限するために使用されるデータストリーム、インデックス、およびエイリアスのカンマ区切りリスト。ワイルドカード (*) をサポートします。すべてのデータストリームとインデックスを対象とするには、このパラメータを省略するか、* または _all を使用します。

Query parameters

  • bytes
  • (オプション、バイトサイズ単位) バイト値を表示するために使用される単位。
  • format
  • (オプション、文字列) HTTP accept header の短縮版。 有効な値には JSON、YAML などが含まれます。
  • h
  • (オプション、文字列) 表示する列名のカンマ区切りリスト。
  • health
  • (オプション、文字列) 返されるインデックスを制限するために使用されるヘルスステータス。有効な値は：
    • green
    • yellow
    • red
      デフォルトでは、レスポンスには任意のヘルスステータスのインデックスが含まれます。
  • help
  • (オプション、ブール値) true の場合、レスポンスにはヘルプ情報が含まれます。デフォルトは false です。
  • include_unloaded_segments
  • (オプション、ブール値) true の場合、レスポンスにはメモリにロードされていないセグメントからの情報が含まれます。デフォルトは false です。
  • master_timeout

  • (オプション、時間単位) マスターノードを待機するための期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは 30s です。リクエストがタイムアウトしないことを示すために -1 に設定することもできます。

  • pri (プライマリシャード)
  • (オプション、ブール値) true の場合、レスポンスにはプライマリシャードからの情報のみが含まれます。デフォルトは false です。
  • s
  • (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • (オプション、時間単位) 時間値を表示するために使用される単位。
  • v
  • (オプション、ブール値) true の場合、レスポンスには列見出しが含まれます。デフォルトは false です。
  • expand_wildcards
  • (オプション、文字列) ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームを対象とできる場合、この引数はワイルドカード式が隠れたデータストリームに一致するかどうかを決定します。カンマ区切りの値をサポートします。例えば open,hidden。 有効な値は：
    • all
    • 隠れた hidden データストリームやインデックスを含む、任意のデータストリームまたはインデックスに一致します。
    • open
    • 開いている非隠れインデックスに一致します。また、非隠れデータストリームにも一致します。
    • closed
    • 閉じた非隠れインデックスに一致します。また、非隠れデータストリームにも一致します。データストリームは閉じることができません。
    • hidden
    • 隠れたデータストリームと隠れたインデックスに一致します。open、closed、またはその両方と組み合わせる必要があります。
    • none
    • ワイルドカードパターンは受け付けられません。

Examples

Python

  1. resp = client.cat.indices(
  2.    index="my-index-*",
  3.    v=True,
  4.    s="index",
  5. )
  6. print(resp)

Ruby

  1. response = client.cat.indices(
  2.   index: 'my-index-*',
  3.   v: true,
  4.   s: 'index'
  5. )
  6. puts response

Js

  1. const response = await client.cat.indices({
  2.   index: "my-index-*",
  3.   v: "true",
  4.   s: "index",
  5. });
  6. console.log(response);

Console

  1. GET /_cat/indices/my-index-*?v=true&s=index

API は以下のレスポンスを返します：

Txt

  1. health status index            uuid                   pri rep docs.count docs.deleted store.size pri.store.size dataset.size
  2. yellow open   my-index-000001  u8FNjxh8Rfy_awN11oDKYQ   1   1       1200            0     88.1kb         88.1kb       88.1kb
  3. green  open   my-index-000002  nYFWZEO7TUiOjLQXBaYJpA   1   0          0            0       260b           260b         260b