cat data frame analytics API

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

データフレーム分析ジョブに関する設定と使用情報を返します。

Request

GET /_cat/ml/data_frame/analytics/<data_frame_analytics_id>

GET /_cat/ml/data_frame/analytics

Prerequisites

Elasticsearchのセキュリティ機能が有効になっている場合、次の権限が必要です：

  • cluster: monitor_ml

詳細については、セキュリティ権限および機械学習セキュリティ権限を参照してください。

Path parameters

  • <data_frame_analytics_id>
  • （オプション、文字列）データフレーム分析ジョブの識別子。このオプションを指定しない場合、APIは最初の100件のデータフレーム分析ジョブに関する情報を返します。

Query parameters

  • format
  • （オプション、文字列）HTTP accept headerの短縮版。妥当な値にはJSON、YAMLなどが含まれます。
  • h
  • （オプション、文字列）表示する列名のカンマ区切りリスト。
    どの列を含めるか指定しない場合、APIはデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみを返します。
    妥当な列は：
    • assignment_explanation, ae
    • ノードの選択に関するメッセージを含みます。
    • create_time, ct, createTime
    • （デフォルト）データフレーム分析ジョブが作成された時刻。
    • description, d
    • ジョブの説明。
    • dest_index, di, destIndex
    • 送信先インデックスの名前。
    • failure_reason, fr, failureReason
    • データフレーム分析ジョブが失敗した理由に関するメッセージを含みます。
    • id
    • （デフォルト）データフレーム分析ジョブの識別子。
    • model_memory_limit, mml, modelMemoryLimit
    • データフレーム分析ジョブに許可される最大メモリリソースの概算。
    • node.address, na, nodeAddress
    • データフレーム分析ジョブが割り当てられているノードのネットワークアドレス。
    • node.ephemeral_id, ne, nodeEphemeralId
    • データフレーム分析ジョブが割り当てられているノードの一時ID。
    • node.id, ni, nodeId
    • データフレーム分析ジョブが割り当てられているノードの一意の識別子。
    • node.name, nn, nodeName
    • データフレーム分析ジョブが割り当てられているノードの名前。
    • progress, p
    • フェーズごとのデータフレーム分析ジョブの進捗報告。
    • source_index, si, sourceIndex
    • ソースインデックスの名前。
    • state, s
    • （デフォルト）データフレーム分析ジョブの現在の状態。
    • type, t
    • （デフォルト）データフレーム分析ジョブが実行する分析のタイプ。
    • version, v
    • データフレーム分析ジョブが作成されたElasticsearchのバージョン番号。
  • help
  • （オプション、Boolean）trueの場合、応答にはヘルプ情報が含まれます。デフォルトはfalseです。
  • s
  • （オプション、文字列）応答をソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • （オプション、時間単位）時間値を表示するために使用される単位。
  • v
  • （オプション、Boolean）trueの場合、応答には列見出しが含まれます。デフォルトはfalseです。

Examples

Python

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

Ruby

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

Js

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

Console

  1. GET _cat/ml/data_frame/analytics?v=true

Console-Result

  1. id               create_time              type             state
  2. classifier_job_1 2020-02-12T11:49:09.594Z classification stopped
  3. classifier_job_2 2020-02-12T11:49:14.479Z classification stopped
  4. classifier_job_3 2020-02-12T11:49:16.928Z classification stopped
  5. classifier_job_4 2020-02-12T11:49:19.127Z classification stopped
  6. classifier_job_5 2020-02-12T11:49:21.349Z classification stopped