المهام غير المتزامنة

إلغاء مهمة

إلغاء مهمة غير متزامنة (async task) موجودة في قائمة الانتظار عندما يدعم النموذج الخاص بها الإلغاء

DELETE
/v1/tasks/{id}

نظرة عامة

استخدم DELETE /v1/tasks/{id} لإلغاء مهمة غير متزامنة لم تبدأ في التنفيذ بعد. استخدم نفس معرف المهمة (task ID) من استجابة الإنشاء أو من poll_url المُعاد.

المهام المدعومة

يتوفر الإلغاء لمهام Seedance الموجودة في قائمة الانتظار باستخدام seedance-2.0 أو seedance-2.5 أو seedance-2.5 عندما تدعم تلك المهمة الإلغاء. لا يمكن إلغاء مهمة قيد التشغيل بالفعل أو في حالة نهائية. لا يتم فرض رسوم على المهمة الملغاة. تظل الحالة قابلة للاستعلام طالما يتم الاحتفاظ بسجل المهمة العام الخاص بها.

لإلغاء مهمة تم إنشاؤها من خلال نقطة نهاية Seedance المتوافقة مع Volc، راجع إلغاء مهمة (متوافقة مع Volc).

معاملات المسار (Path Parameters)

idstringpathمطلوب

معرف المهمة غير المتزامنة الذي تم إرجاعه بواسطة طلب الإنشاء أو المضمن في poll_url.

الاستجابة

idstring

المعرف الأساسي للمهمة غير المتزامنة.

task_idstring

الاسم المستعار لمعرف المهمة غير المتزامنة.

poll_urlstring

رابط حالة المهمة. يظل صالحاً بعد الإلغاء. قم بإجراء استعلام GET /v1/tasks/{id} باستخدام id.

statusstring

حالة المهمة. يتم إرجاع المهمة التي تم إلغاؤها بنجاح كـ failed مع cancelled: true للتوافق مع قيم الحالة الحالية.

cancelledboolean

تكون true عندما يتم إلغاء المهمة قبل التنفيذ.

cancellation_statusstring

مؤشر الإلغاء. تكون القيمة cancelled عند نجاح الإلغاء.

errorstring

سبب الإلغاء أو رسالة فشل المهمة.

سلوك الخطأ

HTTPCodeالمعنى
400missing_task_id, invalid_task_idمعرف المهمة مفقود أو ليس معرف مهمة صالحاً
400unsupported_task_cancelنوع المهمة أو النموذج لا يدعم الإلغاء
403task_not_ownedالمهمة لا تنتمي إلى مساحة العمل الخاصة بمفتاح API هذا
404async_task_not_foundانتهت صلاحية المهمة أو أنها غير متاحة
409task_not_cancellableالمهمة قيد المعالجة بالفعل، أو انتهت، أو لم تعد قابلة للإلغاء. توضح current_status حالتها
503async_task_owner_unavailableلا يمكن قراءة المهمة في الوقت الحالي. حاول مرة أخرى

مثال

الطلب

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

الاستجابة

Response
{
  "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"
}

التفويض

BearerAuth
AuthorizationBearer <token>

مصادقة مفتاح API. قم بإنشاء أو إدارة مفاتيح API في Dashboard > API > API Keys.

الموضع: header

معاملات المسار

id*string

معرف المهمة غير المتزامنة الذي يتم إرجاعه بواسطة id / task_id، أو المضمن في poll_url

الاستجابة

application/json

application/json

application/json

application/json

application/json

application/json

application/json