データフレーム分析ジョブAPIの開始

データフレーム分析ジョブを開始します。

リクエスト

POST _ml/data_frame/analytics/<data_frame_analytics_id>/_start

前提条件

次の権限が必要です：

  • クラスター： manage_ml （machine_learning_admin ビルトインロールがこの権限を付与します）
  • ソースインデックス： read, view_index_metadata
  • 宛先インデックス： read, create_index, manage および index

説明

データフレーム分析ジョブは、そのライフサイクルの間に複数回開始および停止できます。

宛先インデックスが存在しない場合、データフレーム分析ジョブを初めて開始する際に自動的に作成されます。宛先インデックスの index.number_of_shards および index.number_of_replicas 設定は、ソースインデックスからコピーされます。複数のソースインデックスがある場合、宛先インデックスは最も高い設定値をコピーします。宛先インデックスのマッピングもソースインデックスからコピーされます。マッピングの競合がある場合、ジョブは開始に失敗します。

宛先インデックスが存在する場合、そのまま使用されます。したがって、カスタム設定とマッピングで宛先インデックスを事前に設定できます。

Elasticsearchのセキュリティ機能が有効になっている場合、データフレーム分析ジョブはそれを作成したユーザーを記憶し、その資格情報を使用してジョブを実行します。ジョブを作成する際に二次認証ヘッダーを提供した場合、それらの資格情報が使用されます。

パスパラメータ

  • <data_frame_analytics_id>
  • （必須、文字列）データフレーム分析ジョブの識別子。この識別子は、小文字の英数字（a-zおよび0-9）、ハイフン、アンダースコアを含むことができます。英数字で始まり、英数字で終わる必要があります。

クエリパラメータ

  • timeout
  • （オプション、時間単位）データフレーム分析ジョブが開始するまでの待機時間を制御します。デフォルトは20秒です。

レスポンスボディ

  • acknowledged
  • （ブール値）成功したレスポンスの場合、この値は常に true です。失敗した場合は、代わりに例外が返されます。
  • node
  • （文字列）ジョブが開始されたノードのID。ジョブが遅延オープンを許可されており、まだノードに割り当てられていない場合、この値は空の文字列です。

例

次の例は、loganalytics データフレーム分析ジョブを開始します:

Python

  1. resp = client.ml.start_data_frame_analytics(
  2.    id="loganalytics",
  3. )
  4. print(resp)

Js

  1. const response = await client.ml.startDataFrameAnalytics({
  2.   id: "loganalytics",
  3. });
  4. console.log(response);

コンソール

  1. POST _ml/data_frame/analytics/loganalytics/_start

データフレーム分析ジョブが開始されると、次の結果が得られます：

コンソール-結果

  1. {
  2.   "acknowledged" : true,
  3.   "node" : "node-1"
  4. }