変換を停止するAPI

1つ以上の変換を停止します。

リクエスト

POST _transform/<transform_id>/_stop

POST _transform/<transform_id1>,<transform_id2>/_stop

POST _transform/_all/_stop

前提条件

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

パスパラメータ

  • <transform_id>
  • （必須、文字列）変換の識別子。複数の変換を停止するには、カンマ区切りのリストまたはワイルドカード式を使用します。すべての変換を停止するには、_all または * を識別子として使用します。

クエリパラメータ

  • allow_no_match
  • （オプション、ブール値）リクエスト時の動作を指定します：
    • ワイルドカード式を含み、一致する変換がない場合。
    • _all 文字列を含むか、識別子がない場合で、一致がない場合。
    • ワイルドカード式を含み、部分一致のみがある場合。
      デフォルト値は true で、一致がない場合に成功の確認メッセージを返します。部分一致のみがある場合、APIは適切な変換を停止します。たとえば、リクエストに test-id1*,test-id2* が識別子として含まれ、test-id2* に一致する変換がない場合でも、APIは test-id1* に一致する変換を停止します。
      このパラメータが false の場合、一致がないか部分一致のみの場合、リクエストは 404 ステータスコードを返します。
  • force
  • （オプション、ブール値）失敗した変換を停止するために true に設定するか、初期停止リクエストに応答しなかった変換を強制的に停止します。
  • timeout
  • （オプション、時間値）wait_for_completion=true の場合、APIは変換が停止するのを待つ間、指定された期間（最大）ブロックします。timeout 時間が経過した場合、APIはタイムアウト例外をスローします。タイムアウト例外がスローされても、停止リクエストは処理中であり、最終的に変換は STOPPED に移動します。タイムアウトは、単にAPI呼び出し自体がステータス変更を待っている間にタイムアウトしたことを意味します。デフォルトは 30s です。
  • wait_for_checkpoint
  • （オプション、ブール値）true に設定すると、現在のチェックポイントが完了するまで変換は完全に停止しません。false に設定すると、変換はできるだけ早く停止します。デフォルトは false です。
  • wait_for_completion
  • （オプション、ブール値）true に設定すると、インデクサーの状態が完全に停止するまでAPIがブロックされます。false に設定すると、APIはすぐに返し、インデクサーはバックグラウンドで非同期に停止します。デフォルトは false です。

レスポンスコード

  • 404 （リソースが見つかりません）
  • allow_no_match が false の場合、このコードはリクエストに一致するリソースがないか、リクエストに対して部分一致のみがあることを示します。

例

Python

  1. resp = client.transform.stop_transform(
  2.    transform_id="ecommerce_transform",
  3. )
  4. print(resp)

Ruby

  1. response = client.transform.stop_transform(
  2.   transform_id: 'ecommerce_transform'
  3. )
  4. puts response

Js

  1. const response = await client.transform.stopTransform({
  2.   transform_id: "ecommerce_transform",
  3. });
  4. console.log(response);

コンソール

  1. POST _transform/ecommerce_transform/_stop

変換が停止すると、次の結果が得られます：

コンソール-結果

  1. {
  2.   "acknowledged" : true
  3. }