cat transforms API

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

変換に関する設定と使用情報を返します。

Request

GET /_cat/transforms/<transform_id>

GET /_cat/transforms/_all

GET /_cat/transforms/*

GET /_cat/transforms

Prerequisites

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitor_transformクラスター権限が必要です。組み込みのtransform_userロールにはこれらの権限があります。詳細については、Security privilegesおよびBuilt-in rolesを参照してください。

Path parameters

  • <transform_id>
  • （オプション、文字列）変換の識別子。変換識別子またはワイルドカード式であることができます。これらのオプションのいずれかを指定しない場合、APIはすべての変換に関する情報を返します。

Query parameters

  • allow_no_match
  • （オプション、Boolean）リクエスト時の動作を指定します：
    • ワイルドカード式を含み、一致する変換がない場合。
    • _all文字列を含むか、識別子がない場合、一致がない場合。
    • ワイルドカード式を含み、部分一致のみがある場合。
      デフォルト値はtrueで、一致がない場合は空のtransforms配列を返し、部分一致がある場合は結果のサブセットを返します。
      このパラメータがfalseの場合、リクエストは一致がない場合または部分一致のみがある場合に404ステータスコードを返します。
  • format
  • （オプション、文字列）HTTP accept headerの短縮版。有効な値にはJSON、YAMLなどが含まれます。
  • from
  • （オプション、整数）指定された数の変換をスキップします。デフォルト値は0です。
  • h
  • （オプション、文字列）表示する列名のカンマ区切りリスト。
    どの列を含めるか指定しない場合、APIはデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみを返します。
    有効な列は：
    • changes_last_detection_time, cldt
    • （デフォルト）ソースインデックスで最後に変更が検出されたタイムスタンプ。
    • checkpoint, cp
    • （デフォルト）チェックポイントのシーケンス番号。
    • checkpoint_duration_time_exp_avg, cdtea, checkpointTimeExpAvg
    • チェックポイントの持続時間の指数移動平均（ミリ秒単位）。
    • checkpoint_progress, c, checkpointProgress
    • （デフォルト）現在進行中の次のチェックポイントの進捗。
    • create_time, ct, createTime
    • 変換が作成された時間。
    • delete_time, dtime
    • 削除にかかった時間（ミリ秒単位）。
    • description, d
    • 変換の説明。
    • dest_index, di, destIndex
    • 変換の宛先インデックス。

pivot変換の場合、宛先インデックスのマッピングは可能な限りソースフィールドに基づいて推測されます。代替マッピングが必要な場合は、変換を開始する前にCreate index APIを使用してください。

latest変換の場合、マッピングは決して推測されません。宛先インデックスの動的マッピングが望ましくない場合は、変換を開始する前にCreate index APIを使用してください。

  • documents_deleted, docd
  • この変換の保持ポリシーにより、宛先インデックスから削除されたドキュメントの数。
  • documents_indexed, doci
  • 変換の宛先インデックスにインデックスされたドキュメントの数。
  • docs_per_second, dps
  • 1秒あたりの入力ドキュメントの数に制限を指定します。この設定は、検索リクエストの間に待機時間を追加することによって変換を制限します。デフォルト値はnullで、スロットリングを無効にします。
  • documents_processed, docp
  • （デフォルト）変換のソースインデックスから処理されたドキュメントの数。
  • frequency, f
  • 変換が継続的に実行されているときのソースインデックスの変更をチェックする間隔。最小値は1s、最大値は1hです。デフォルト値は1mです。
  • id
  • （デフォルト）変換の識別子。
  • index_failure, if
  • インデックスの失敗の数。
  • index_time, itime
  • インデックスにかかった時間（ミリ秒単位）。
  • index_total, it
  • インデックス操作の数。
  • indexed_documents_exp_avg, idea
  • インデックスされた新しいドキュメントの数の指数移動平均。
  • last_search_time, lst, lastSearchTime
  • （デフォルト）ソースインデックスでの最後の検索のタイムスタンプ。このフィールドは、変換が実行中の場合のみ表示されます。
  • max_page_search_size, mpsz
  • 各チェックポイントの合成集約に使用する初期ページサイズを定義します。サーキットブレーカー例外が発生した場合、ページサイズは動的に低い値に調整されます。最小値は10、最大値は65,536です。デフォルト値は500です。
  • pages_processed, pp
  • 処理された検索またはバルクインデックス操作の数。ドキュメントは個別ではなくバッチで処理されます。
  • pipeline, p
  • ingest pipelineのユニークな識別子。
  • processed_documents_exp_avg, pdea
  • 処理されたドキュメントの数の指数移動平均。
  • processing_time, pt
  • 結果の処理にかかった時間（ミリ秒単位）。
  • reason, r
  • 変換がfailed状態の場合、このプロパティは失敗の理由に関する詳細を提供します。
  • search_failure, sf
  • 検索の失敗の数。
  • search_time, stime
  • 検索にかかった時間（ミリ秒単位）。
  • search_total, st
  • 変換のソースインデックスでの検索操作の数。
  • source_index, si, sourceIndex
  • （デフォルト）変換のソースインデックス。単一のインデックス、インデックスパターン（例："my-index-*"）、インデックスの配列（例：["my-index-000001", "my-index-000002"]）、またはインデックスパターンの配列（例：["my-index-*", "my-other-index-*"]）であることができます。リモートインデックスの場合は、"remote_name:index_name"構文を使用します。
    リモートクラスターにインデックスがある場合、マスターノードと少なくとも1つの変換ノードはremote_cluster_clientノードロールを持っている必要があります。
  • state, s
  • （デフォルト）変換のステータスで、次の値のいずれかになります：
    • aborting：変換が中止されています。
    • failed：変換が失敗しました。失敗の詳細については、理由フィールドを確認してください。
    • indexing：変換がデータを積極的に処理し、新しいドキュメントを作成しています。
    • started：変換は実行中ですが、データを積極的にインデックスしていません。
    • stopped：変換が停止しました。
    • stopping：変換が停止中です。
  • transform_type, tt
  • 変換のタイプを示します：batchまたはcontinuous。
  • trigger_count, tc
  • スケジューラによって変換がトリガーされた回数。たとえば、スケジューラは、frequencyプロパティで指定された間隔で更新を確認したり、新しいデータを取り込んだりするために変換インデクサをトリガーします。
  • version, v
  • 変換が作成されたときにノード上に存在したElasticsearchのバージョン。
    • help
    • （オプション、Boolean）trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
    • s
    • （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
    • size
    • （オプション、整数）取得する変換の最大数を指定します。デフォルト値は100です。
    • time
    • （オプション、時間単位）時間値を表示するために使用される単位。
    • v
    • （オプション、Boolean）trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.transforms(
  2.    v=True,
  3.    format="json",
  4. )
  5. print(resp)

Ruby

  1. response = client.cat.transforms(
  2.   v: true,
  3.   format: 'json'
  4. )
  5. puts response

Js

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

Console

  1. GET /_cat/transforms?v=true&format=json

Console-Result

  1. [
  2.   {
  3.    "id" : "ecommerce_transform",
  4.    "state" : "started",
  5.    "checkpoint" : "1",
  6.    "documents_processed" : "705",
  7.    "checkpoint_progress" : "100.00",
  8.    "changes_last_detection_time" : null
  9.   }
  10. ]