cat segments API

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

インデックスシャード内のLuceneセグメントに関する低レベルの情報を返します。これはindices segments APIに似ています。

データストリームの場合、APIはストリームのバックインデックスに関する情報を返します。

Request

GET /_cat/segments/<target>

GET /_cat/segments

Prerequisites

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

Path parameters

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

Query parameters

  • bytes
  • （オプション、バイトサイズ単位）バイト値を表示するために使用される単位。
  • format
  • （オプション、文字列）HTTP accept headerの短縮版。有効な値にはJSON、YAMLなどが含まれます。
  • h
  • （オプション、文字列）表示する列名のカンマ区切りリスト。
    どの列を含めるか指定しない場合、APIは以下にリストされたデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみが返されます。
    有効な列は：
    • index, i, idx
    • （デフォルト）インデックスの名前。
    • shard, s, sh
    • （デフォルト）シャードの名前。
    • prirep, p, pr, primaryOrReplica
    • （デフォルト）シャードタイプ。返される値はprimaryまたはreplicaです。
    • ip
    • （デフォルト）セグメントのシャードのIPアドレス、例えば127.0.1.1。
    • segment
    • （デフォルト）セグメントの名前、例えば_0。セグメント名はセグメント生成から派生し、シャードのディレクトリ内のファイル名を作成するために内部的に使用されます。
    • generation
    • （デフォルト）生成番号、例えば0。Elasticsearchは書き込まれた各セグメントに対してこの生成番号をインクリメントします。Elasticsearchはこの番号を使用してセグメント名を導出します。
    • docs.count
    • （デフォルト）Luceneによって報告されたドキュメントの数。これは削除されたドキュメントを除外し、ネストされたドキュメントを親から別々にカウントします。また、最近インデックスされたドキュメントで、まだセグメントに属していないものも除外されます。
    • docs.deleted
    • （デフォルト）Luceneによって報告された削除されたドキュメントの数。これは、実行した削除操作の数よりも多い場合や少ない場合があります。この数は、最近実行された削除で、まだセグメントに属していないものを除外します。削除されたドキュメントは、自動マージプロセスによってクリーンアップされます。さらに、Elasticsearchはシャード上の操作の最近の履歴を内部的に追跡するために追加の削除されたドキュメントを作成します。
    • size
    • （デフォルト）セグメントによって使用されるディスクスペース、例えば50kb。
    • size.memory
    • （デフォルト）効率的な検索のためにメモリに保存されているセグメントデータのバイト数、例えば1264。
      -1の値は、Elasticsearchがこの数を計算できなかったことを示します。
    • committed
    • （デフォルト）trueの場合、セグメントはディスクに同期されます。同期されたセグメントは、ハードリブートを生き延びることができます。
      falseの場合、未コミットのセグメントからのデータもトランザクションログに保存され、Elasticsearchが次回の起動時に変更を再生できるようになります。
    • searchable
    • （デフォルト）trueの場合、セグメントは検索可能です。
      falseの場合、セグメントはディスクに書き込まれた可能性が高いですが、検索可能になるためにはリフレッシュが必要です。
    • version
    • （デフォルト）セグメントを書き込むために使用されたLuceneのバージョン。
    • compound
    • （デフォルト）trueの場合、セグメントは複合ファイルに保存されます。これは、Luceneがセグメントのすべてのファイルを1つのファイルにマージしてファイルディスクリプタを節約することを意味します。
    • id
    • ノードのID、例えばk0zy。
  • help
  • （オプション、ブール値）trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
  • s
  • （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • v
  • （オプション、ブール値）trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.segments(
  2.    v=True,
  3. )
  4. print(resp)

Ruby

  1. response = client.cat.segments(
  2.   v: true
  3. )
  4. puts response

Js

  1. const response = await client.cat.segments({
  2.   v: "true",
  3. });
  4. console.log(response);

Console

  1. GET /_cat/segments?v=true

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

Txt

  1. index shard prirep ip        segment generation docs.count docs.deleted size size.memory committed searchable version compound
  2. test  0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.11.1   true
  3. test1 0     p      127.0.0.1 _0               0          1            0  3kb           0 false     true       9.11.1   true