Tâches asynchrones
Annuler une tâche
Annuler une tâche asynchrone en file d'attente lorsque son modèle prend en charge l'annulation
Aperçu
Utilisez DELETE /v1/tasks/{id} pour annuler une tâche asynchrone qui n'a pas encore commencé à s'exécuter. Utilisez le même ID de tâche provenant de la réponse de création ou de l'URL poll_url renvoyée.
Tâches prises en charge
L'annulation est disponible pour les tâches Seedance en file d'attente utilisant seedance-2.0, seedance-2.5 ou seedance-2.5 lorsque cette tâche prend en charge l'annulation. Une tâche déjà en cours d'exécution ou dans un état terminal ne peut pas être annulée. Une tâche annulée n'est pas facturée. Le statut reste consultable tant que son enregistrement de tâche public est conservé.
Pour annuler une tâche créée via le point de terminaison Seedance compatible Volc, consultez Annuler une tâche (compatible Volc).
Paramètres de chemin
L'ID de la tâche asynchrone renvoyé par la requête de création ou intégré dans poll_url.
Réponse
Identifiant canonique de la tâche asynchrone.
Alias de l'identifiant de la tâche asynchrone.
URL de statut de la tâche. Elle reste valide après l'annulation. Interrogez GET /v1/tasks/{id} avec id.
Statut de la tâche. Une tâche annulée avec succès est renvoyée comme failed avec cancelled: true pour assurer la compatibilité avec les valeurs de statut existantes.
true lorsque la tâche a été annulée avant son exécution.
Marqueur d'annulation. La valeur est cancelled lorsque l'annulation réussit.
Raison de l'annulation ou message d'échec de la tâche.
Comportement en cas d'erreur
| HTTP | Code | Signification |
|---|---|---|
400 | missing_task_id, invalid_task_id | L'ID de la tâche est manquant ou n'est pas un ID de tâche valide |
400 | unsupported_task_cancel | Le type de tâche ou le modèle ne prend pas en charge l'annulation |
403 | task_not_owned | La tâche n'appartient pas à l'espace de travail de cette clé API |
404 | async_task_not_found | La tâche a expiré ou n'est pas disponible |
409 | task_not_cancellable | La tâche est déjà en cours de traitement, terminée ou n'est plus annulable. current_status indique son état |
503 | async_task_owner_unavailable | La tâche ne peut pas être lue pour le moment. Réessayez |
Requête
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"Réponse
{
"id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"status": "failed",
"cancelled": true,
"cancellation_status": "cancelled",
"error": "Task cancelled before execution"
}Autorisation
BearerAuth Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.
Emplacement: header
Paramètres de chemin
L'ID de tâche asynchrone renvoyé par id / task_id, ou intégré dans poll_url
Réponse
application/json
application/json
application/json
application/json
application/json
application/json
application/json