POST /api/v1/forward/batches/{batch_id}/cancel
取消が発行されると、Forward はキューをドレインして pending タスクを cancelled にマークし、実行中の各タスクに対して CancelSession を呼び出します。
Headers
Path parameters
Example request
Example response
HTTP 200 OKstatus は中間状態の cancelling、残っていなければ直接 cancelled を返します。すでに終端状態にあるバッチはべき等に現在のオブジェクトを返します。
Response fields
取消フロー
- 終端状態のバッチ:
200をべき等に返し、操作は行いません。 - CAS がステータスを
validating|queued|processing → cancellingに遷移させます。 - Redis キューをドレインし、pending タスクを一括で
cancelledにマークします。 - 実行中の各タスクに対して
CancelSessionを呼び出します。 - 実行中タスクが残っていなければ即座に
finalizeを起動、残っていれば最後のCompleteTaskがfinalizeを駆動します。
Error codes
Notes
- 取消は非同期処理です。
cancellingはリクエストが受理されたことを意味します。詳細をポーリングして終端状態を確認してください。 - すでに終端状態のバッチへの取消はべき等で、
200を返します。