Annuler une exécution

curl --request POST \
  --url https://api.example.com/v1/runs/{run_id}/cancel

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/runs/{run_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/runs/{run_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs/{run_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "run_id": "<string>",
  "namespace": "<string>",
  "app_name": "<string>",
  "app_version": "<string>",
  "build_id": "<string>",
  "run_kind": "<string>",
  "state": {},
  "input": {},
  "progress": {
    "done": 123,
    "total": 123,
    "status_text": "<string>"
  },
  "dataset_id": "<string>",
  "partial": true,
  "cancel_requested": true,
  "triggered_by": "<string>",
  "upstream_ref": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "first_started_at": "<string>",
  "finished_at": "<string>",
  "usage": {
    "metrics": {},
    "duration_ms": 123
  },
  "billing": {
    "events": [
      {
        "event": "<string>",
        "label": "<string>",
        "qty": 123,
        "unit_price": 123,
        "amount": 123,
        "unit_size": 123,
        "raw_qty": 123
      }
    ],
    "total": 123,
    "currency": "<string>",
    "charged": true
  },
  "error": {
    "code": "<string>",
    "category": "<string>",
    "message": "<string>",
    "retryable": true,
    "retry_after": 123,
    "item_index": 123,
    "details": [
      {}
    ]
  },
  "sample_records": [
    {}
  ],
  "warnings": [
    {
      "code": "<string>",
      "event": "<string>",
      "detail": {},
      "count": 123,
      "updated_at": "<string>"
    }
  ]
}

POST

runs

{run_id}

cancel

Annuler une exécution

curl --request POST \
  --url https://api.example.com/v1/runs/{run_id}/cancel

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/runs/{run_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/runs/{run_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs/{run_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "run_id": "<string>",
  "namespace": "<string>",
  "app_name": "<string>",
  "app_version": "<string>",
  "build_id": "<string>",
  "run_kind": "<string>",
  "state": {},
  "input": {},
  "progress": {
    "done": 123,
    "total": 123,
    "status_text": "<string>"
  },
  "dataset_id": "<string>",
  "partial": true,
  "cancel_requested": true,
  "triggered_by": "<string>",
  "upstream_ref": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "first_started_at": "<string>",
  "finished_at": "<string>",
  "usage": {
    "metrics": {},
    "duration_ms": 123
  },
  "billing": {
    "events": [
      {
        "event": "<string>",
        "label": "<string>",
        "qty": 123,
        "unit_price": 123,
        "amount": 123,
        "unit_size": 123,
        "raw_qty": 123
      }
    ],
    "total": 123,
    "currency": "<string>",
    "charged": true
  },
  "error": {
    "code": "<string>",
    "category": "<string>",
    "message": "<string>",
    "retryable": true,
    "retry_after": 123,
    "item_index": 123,
    "details": [
      {}
    ]
  },
  "sample_records": [
    {}
  ],
  "warnings": [
    {
      "code": "<string>",
      "event": "<string>",
      "detail": {},
      "count": 123,
      "updated_at": "<string>"
    }
  ]
}

POST https://api-datahub.octoparse.com/v1/runs/{run_id}/cancel Authentification : clé API requise (Authorization: Bearer <API Key>). Envoie un signal d’annulation et attend brièvement (jusqu’à 5 secondes) la réponse de l’exécuteur, puis renvoie l’objet d’exécution actuel. Les exécutions en file s’arrêtent immédiatement ; celles en cours s’arrêtent en général de façon coopérative en quelques secondes. Les enregistrements déjà écrits sont conservés (partial vaut true), restent lisibles et ne sont facturés que pour ce qui a été produit. La propriété correspond au détail d’exécution : vous ne pouvez annuler que les exécutions que vous avez démarrées. Après annulation, confirmez l’état terminal avec Obtenir une exécution.

Requête

Paramètres de chemin

string

requis

Id de l’exécution.

Exemple de requête

curl -X POST \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/runs/run_c62bc0fb8df2/cancel"

Réponse

200 succès

{
  "data": {
    "run_id": "run_c62bc0fb8df2",
    "namespace": "carol",
    "app_name": "probe-b",
    "app_version": "0.1.0",
    "build_id": null,
    "run_kind": "production",
    "state": "SUCCEEDED",
    "input": {
      "product": "p-now"
    },
    "progress": {
      "done": 20,
      "total": null,
      "status_text": null
    },
    "dataset_id": "ds_0bd5345d13d0",
    "partial": false,
    "cancel_requested": false,
    "triggered_by": "api",
    "upstream_ref": null,
    "created_at": "2026-09-15T07:45:40.411993+00:00",
    "started_at": "2026-09-15T07:45:40.419610+00:00",
    "first_started_at": "2026-09-15T07:45:40.419610+00:00",
    "finished_at": "2026-09-15T07:45:40.822250+00:00",
    "usage": {
      "metrics": {
        "records_collected": 20
      },
      "duration_ms": 402
    },
    "billing": {
      "events": [
        {
          "event": "record",
          "label": "One record",
          "qty": 20.0,
          "unit_price": 0.001,
          "amount": 0.02,
          "unit_size": null,
          "raw_qty": null
        }
      ],
      "total": 0.02,
      "currency": "USD",
      "charged": true
    },
    "error": null,
    "sample_records": null,
    "warnings": []
  }
}

Renvoie un objet d’exécution. Les champs correspondent à Démarrer une exécution. La charge utile est encapsulée dans data. Champs :

string

requis

—

string

—

string

—

string

—

string

—

string

—

enum

requis

Values: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.

object

—

object

—

Afficher fields

integer

—

integer

—

string

—

string

—

boolean

—

boolean

true tant que l’annulation a été demandée et que l’exécution se termine encore (arrêt coopératif / récupération de résultat partiel). Toujours false en états terminaux (normalisé côté serveur), donc les clients n’ont pas à le dériver de state.

string

—

string

—

string

—

string

—

string

Quand un worker a réclamé l’exécution pour la première fois. Contrairement à started_at, ce n’est jamais réécrit en cas de réessai, donc c’est l’ancre du temps en file : en file = first_started_at - created_at, et temps total mur = finished_at - first_started_at. Dériver le temps en file de started_at compte les tentatives antérieures comme file. null seulement pour les exécutions jamais réclamées.

string

—

object

Mesure objective d’usage : ce que l’exécution a fait. Séparée de la facturation ; c’est ce que comparent les évaluations.

Afficher fields

object

—

integer

—

object

Grand livre de facturation = usage × tarifs × règles de facturation : combien est facturé.

Afficher fields

object[]

—

Afficher fields

string

requis

—

string

—

number

requis

—

number

requis

—

number

requis

—

integer

—

number

—

number

—

string

—

boolean

—

object

—

Afficher fields

string

requis

—

string

—

string

requis

—

boolean

—

number

—

integer

—

object[]

—

object[]

—

object[]

—

Afficher fields

string

requis

—

string

—

object

—

integer

—

string

—

Erreurs

HTTP	`code`	`category`	Description
401	`unauthorized`	`forbidden`	Clé API manquante ou invalide.
404	`run-not-found`	`not_found`	L’exécution n’existe pas, ou n’a pas été démarrée par le compte actuel.
409	`run-terminal`	`invalid_input`	L’exécution est déjà terminée et ne peut pas être annulée.

Les réponses d’erreur utilisent {"error": {code, category, message, retryable}}. Voir Erreurs.

Bibliothèques clientes

run = client.cancel("run_c62bc0fb8df2")
print(run["state"], run["partial"], run["cancel_requested"])

const run = await client.cancel("run_c62bc0fb8df2");
console.log(run.state, run.partial, run.cancel_requested);

BIEN DÉMARRER

DÉMARRAGE RAPIDE

RÉFÉRENCE

DATA HUB API

Annuler une exécution

Requête

Paramètres de chemin

Exemple de requête

Réponse

200 succès

Erreurs

Bibliothèques clientes

​Requête

​Paramètres de chemin

​Exemple de requête

​Réponse

​200 succès

​Erreurs

​Bibliothèques clientes

Requête

Paramètres de chemin

Exemple de requête

Réponse

200 succès

Erreurs

Bibliothèques clientes