Runs & Results
Cancelar una ejecución
Envía una señal de cancelación y devuelve el objeto de ejecución actual.
POST
Cancelar una ejecución
POST https://api-datahub.octoparse.com/v1/runs/{run_id}/cancel
Autenticación: se requiere API key (Authorization: Bearer <API Key>).
Envía una señal de cancelación y espera brevemente (hasta 5 segundos) la respuesta del ejecutor, luego devuelve el objeto de ejecución actual. Las ejecuciones en cola se detienen de inmediato; las en curso suelen detenerse de forma cooperativa en unos segundos. Los registros ya escritos se conservan (partial es true), siguen siendo legibles y solo se facturan por lo producido.
La propiedad coincide con el detalle de ejecución: solo puedes cancelar ejecuciones que iniciaste. Tras cancelar, confirma el estado terminal con Obtener una ejecución.
Solicitud
Parámetros de ruta
string
requerido
Id de la ejecución.
Ejemplo de solicitud
Respuesta
200 correcto
data. Campos:
string
requerido
—
string
—
string
—
string
—
string
—
string
—
enum
requerido
Values:
PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.object
—
object
—
string
—
boolean
—
boolean
true mientras se ha solicitado la cancelación y la ejecución aún se está deteniendo (parada cooperativa / recuperación de resultado parcial). Siempre false en estados terminales (normalizado en el servidor), así que los clientes no necesitan derivarlo de state.string
—
string
—
string
—
string
—
string
Cuando un worker reclamó la ejecución por primera vez. A diferencia de
started_at, no se reescribe en reintentos, así que es el ancla del tiempo en cola: en cola = first_started_at - created_at, y tiempo total de pared = finished_at - first_started_at. Derivar el tiempo en cola de started_at cuenta intentos anteriores como cola. null solo en ejecuciones nunca reclamadas.string
—
object
Medición objetiva de uso: cuánto hizo la ejecución. Separada de la facturación; es lo que comparan las evaluaciones.
object
Libro de facturación = uso × precios × reglas de facturación: cuánto se cobra.
object
—
object[]
—
object[]
—
Errores
Las respuestas de error usan
{"error": {code, category, message, retryable}}. Véase Errores.