Skip to main content
POST
Annulla un’esecuzione
POST https://api-datahub.octoparse.com/v1/runs/{run_id}/cancel Autenticazione: API key obbligatoria (Authorization: Bearer <API Key>). Invia un segnale di cancel e attende brevemente (fino a 5 secondi) la risposta dell’executor, poi restituisce l’oggetto run corrente. Le run in coda si fermano subito; quelle running di solito in modo cooperativo in pochi secondi. I record già scritti restano (partial è true), leggibili, e sono fatturati solo per quanto prodotto. La ownership coincide col dettaglio run: puoi annullare solo le run che hai avviato. Dopo cancel conferma lo stato terminale con Ottieni un’esecuzione.

Richiesta

Parametri di percorso

string
obbligatorio
ID del run.

Esempio di richiesta

Risposta

200 successo

Restituisce un oggetto run. I campi corrispondono a Start a run. Il payload è wrappato in data. Campi:
string
obbligatorio
string
string
string
string
string
enum
obbligatorio
Valori: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.
object
object
string
boolean
boolean
true mentre l’annullamento è stato richiesto e il run è ancora in fase di chiusura (arresto cooperativo / recupero dei risultati parziali). Sempre false negli stati terminali (normalizzato lato server), quindi i client non devono ricavarlo da state.
string
string
string
string
string
Quando un worker ha claimato la run la prima volta. A differenza di started_at non viene mai riscritto al retry: ancora per il tempo in coda: queued = first_started_at - created_at, wall time totale = finished_at - first_started_at. Derivare il tempo in coda da started_at conta i tentativi precedenti come queueing. null solo per run mai claimate.
string
object
Metering usage oggettivo: quanto ha fatto la run. Separato dalla fatturazione; è ciò che le evaluation confrontano.
object
Registro di fatturazione = utilizzo × prezzi × regole di fatturazione: quanto viene addebitato.
object
object[]
object[]

Errori

Le risposte di errore usano {"error": {code, category, message, retryable}}. Vedi Errori.

Librerie client