Skip to main content
POST
Run abbrechen
POST https://api-datahub.octoparse.com/v1/runs/{run_id}/cancel Authentifizierung: API-Schlüssel erforderlich (Authorization: Bearer <API Key>). Sendet ein Cancel-Signal, wartet kurz (bis 5 Sekunden) auf die Executor-Antwort und gibt das aktuelle Run-Objekt zurück. Gequeuete Runs stoppen sofort; laufende meist kooperativ in wenigen Sekunden. Bereits geschriebene Datensätze bleiben (partial = true), lesbar, und nur das Produzierte wird abgerechnet. Ownership entspricht Run-Detail: Sie können nur selbst gestartete Runs abbrechen. Nach Cancel den terminalen Status mit Run abrufen bestätigen.

Anfrage

Pfadparameter

string
erforderlich
Run-ID.

Beispielanfrage

Antwort

200 Erfolg

Liefert ein Run-Objekt. Die Felder entsprechen Start a run. Payload ist in data gewrappt. Felder:
string
erforderlich
string
string
string
string
string
enum
erforderlich
Werte: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.
object
object
string
boolean
boolean
true, solange ein Abbruch angefordert wurde und der Run noch ausläuft (kooperativer Stopp / Wiederherstellung von Teilergebnissen). In Endzuständen immer false (serverseitig normalisiert), sodass Clients es nicht aus state ableiten müssen.
string
string
string
string
string
Wann ein Worker den Run zuerst geclaimed hat. Anders als started_at wird dies bei Retry nie überschrieben — Anker für Queue-Zeit: queued = first_started_at - created_at, Gesamtwandzeit = finished_at - first_started_at. Queue-Zeit aus started_at abzuleiten zählt frühere Attempts als Queuing. null nur bei nie geclaimten Runs.
string
object
Objektives Usage-Metering: wie viel der Run geleistet hat. Getrennt von der Abrechnung; das vergleichen Evaluations.
object
Abrechnungsbuch = Nutzung × Preise × Abrechnungsregeln: wie viel berechnet wird.
object
object[]
object[]

Fehler

Fehlerantworten nutzen {"error": {code, category, message, retryable}}. Siehe Fehler.

Client-Bibliotheken