機械学習データフレーム分析API - データフレーム分析ジョブを停止（Stop data frame analytics jobs）

データフレーム分析ジョブの停止API

1つ以上のデータフレーム分析ジョブを停止します。

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

POST _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stop

POST _ml/data_frame/analytics/_all/_stop

manage_ml クラスター権限が必要です。この権限は machine_learning_admin ビルトインロールに含まれています。

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

カンマ区切りのデータフレーム分析ジョブのリストまたはワイルドカード式を使用して、1回のAPIリクエストで複数のデータフレーム分析ジョブを停止できます。_allを使用するか、*をとして指定することで、すべてのデータフレーム分析ジョブを停止できます。

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

allow_no_match
(オプション、Boolean) リクエスト時の動作を指定します:
- ワイルドカード式を含み、一致するデータフレーム分析ジョブがない場合。
- _all 文字列を含むか、識別子がない場合、一致がない場合。
- ワイルドカード式を含み、部分一致のみがある場合。
  デフォルト値は true で、一致がない場合は空の data_frame_analytics 配列を返し、部分一致がある場合は結果のサブセットを返します。このパラメータが false の場合、一致がないか部分一致のみの場合、リクエストは 404 ステータスコードを返します。
force
(オプション、Boolean) trueの場合、データフレーム分析ジョブが強制的に停止されます。
timeout
(オプション、時間単位) データフレーム分析ジョブが停止するまでの待機時間を制御します。デフォルトは20秒です。

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

resp = client.ml.stop_data_frame_analytics(
   id="loganalytics",
)
print(resp)

response = client.ml.stop_data_frame_analytics(
  id: 'loganalytics'
)
puts response

const response = await client.ml.stopDataFrameAnalytics({
  id: "loganalytics",
});
console.log(response);

POST _ml/data_frame/analytics/loganalytics/_stop

データフレーム分析ジョブが停止すると、次の結果が得られます:

{
  "stopped" : true
}