メインコンテンツへスキップ
POST /api/v1/forward/batches/{batch_id}/cancel 取消が発行されると、Forward はキューをドレインして pending タスクを cancelled にマークし、実行中の各タスクに対して CancelSession を呼び出します。

Headers

Path parameters

Example request

Example response

HTTP 200 OK
レスポンスは取消発行時点のスナップショットです。実行中タスクが残っていれば status は中間状態の cancelling、残っていなければ直接 cancelled を返します。すでに終端状態にあるバッチはべき等に現在のオブジェクトを返します。

Response fields

取消フロー

  1. 終端状態のバッチ: 200 をべき等に返し、操作は行いません。
  2. CAS がステータスを validating|queued|processing → cancelling に遷移させます。
  3. Redis キューをドレインし、pending タスクを一括で cancelled にマークします。
  4. 実行中の各タスクに対して CancelSession を呼び出します。
  5. 実行中タスクが残っていなければ即座に finalize を起動、残っていれば最後の CompleteTaskfinalize を駆動します。

Error codes

Notes

  • 取消は非同期処理です。cancelling はリクエストが受理されたことを意味します。詳細をポーリングして終端状態を確認してください。
  • すでに終端状態のバッチへの取消はべき等で、200 を返します。

バッチを取得

出力ファイルの取得