Skip to main content
POST
実行を取消
POST https://api-datahub.octoparse.com/v1/runs/{run_id}/cancel 認証:APIキー必須(Authorization: Bearer <API Key>)。 取消シグナルを送り、実行側の応答を短時間(最大 5 秒)待ってから現在の実行オブジェクトを返す。キュー中は即停止。実行中は通常数秒以内に協調停止するが、最終状態は「実行を取得」で確認。 所有権は実行詳細と同じ: 自分が開始した実行のみ取消可。取消後、終端は「実行を取得」で確認。

リクエスト

パスパラメータ

string
必須
実行 id。

リクエスト例

レスポンス

200 成功

実行オブジェクトを返す。フィールドは 実行を開始 と同じ。 ペイロードは data に包まれます。フィールド:
string
必須
string
string
string
string
string
enum
必須
値: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED
object
object
string
boolean
boolean
取消要求済みで収束中なら true(協調停止/部分結果回収)。終端では常に false(サーバ正規化)。state から導出不要。
string
string
string
string
string
ワーカーが初めて実行を引き受けた時刻。started_at と違いリトライで上書きされないため壁時計の基準: queued = first_started_at - created_at、総壁時間 = finished_at - first_started_atstarted_at から queued を取ると以前の試行を待ちと誤算。未割当のみ null
string
object
客観使用量: 実行が何をしたか。課金と分離。評価比較の基準。
object
課金台帳 = 使用量 × 料金 × 課金ルール。
object
object[]
object[]

エラー

エラー応答は {"error": {code, category, message, retryable}} です。エラー を参照。

クライアントライブラリ