Skip to main content
GET
Run abrufen
GET https://api-datahub.octoparse.com/v1/runs/{run_id} Authentifizierung: API-Schlüssel erforderlich (Authorization: Bearer <API Key>). Status, Fortschritt, Fehlerobjekt, Upstream-Referenz, Usage und Abrechnung. Bei wait > 0 hält der Server die Verbindung bis terminal oder Timeout. Ist noch nicht terminal, erneut mit demselben wait aufrufen. Nicht häufig mit wait=0 pollen. Sie können nur selbst gestartete Runs lesen. run_id eines anderen Accounts und fehlende run_id liefern beide 404. Im Input-Vertrag als sensitive markierte Felder sind beim Echo redacted: Write-only-Klartext, den selbst der Starter nicht zurücklesen kann.

Anfrage

Pfadparameter

string
erforderlich
Run-ID.

Abfrageparameter

number
Standard:"0"
Long-poll seconds, 0–60. Standard 0 gibt zurück immediately.Bereich 0 bis 60.

Beispielanfrage

Antwort

200 Erfolg

Die Felder entsprechen der Antwort von 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