Thunderbit Open API home page
サポートAPIコンソール
Extract

バッチ抽出ジョブのキャンセル

DELETE
/batch/extract/{id}
バッチ抽出ジョブのキャンセル

実行中のバッチ抽出ジョブをキャンセルします。一度キャンセルすると再開できません。

ユースケース：

  • 誤って投入した大規模バッチを停止
  • 時間がかかりすぎているジョブをキャンセル
  • 他のジョブのためにリソースを解放

注意： ステータスが PENDING または PROCESSING のジョブのみキャンセル可能。COMPLETED または FAILED 済みのジョブはキャンセルできません。

レスポンス： 成功時は 204 No Content（本文なし）を返します。

URL 単位の可視性： キャンセルはバッチ全体を停止します —— 個別の URL のみのキャンセルはできません。キャンセル前に現在処理中の URL を確認したい場合は GET /batch/extract/{id} を呼び出してください。レスポンスの results 配列に各 URL の status（PENDING / PROCESSING / SUCCEEDED / FAILED）が含まれており、進捗を確認した上でキャンセルできます。

認証

YOUR_API_KEY
認証Bearer <token>

Thunderbit Dashboard から API キーを取得してください。ヘッダー形式：Authorization: Bearer YOUR_API_KEY

位置: header

パスパラメータ

id*string必須

バッチタスク ID

レスポンス

application/json

Job cancelled successfully

successboolean
例：
true