メインコンテンツへスキップ
POST
バッチをキャンセルする
送信した直後にタイプミスを見つけましたか? 誰にでも起こることです。バッチをキャンセルすれば、正常に完了したアイテムに対してのみ料金が発生します。
  • すでに完了: 請求済み。これらの結果は完了しており、あなたを待っています。
  • まだキューにある: 実行されておらず、請求もされません。ここが節約ポイントです。
  • 現在実行中: 通常通り、成功したアイテムに対してのみ料金が発生します。
すでに消費されたクレジットは返金されませんが、バッチの残りは費用がかかりません。
キャンセル後: 実行中のアイテムが完了するかタイムアウトするまで、バッチは in_progress と表示されることがあります。Batch Info で進捗を確認してください。同じバッチに対して再度キャンセルを呼び出しても安全です。

承認

Authorization
string
header
必須

Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。

パスパラメータ

batch_id
string
必須

キャンセルするバッチのID。

レスポンス

バッチ全体のキャンセルサマリー。

total_count
integer
必須

バッチ内の合計アイテム数。

done_count
integer
必須

この呼び出しの前にすでに完了またはキャンセルされたアイテム。

in_flight_count
integer
必須

すでに実行中のアイテム。これらはキャンセルされません。

canceled_count
integer
必須

この呼び出しによってキャンセルされたキューに入っているアイテム。