مرجع API

طلب إلغاء مهمة فيديو

POST/v1/videos/{task_id}/cancel

يعتمد الإلغاء على النموذج/المهمة؛ وتعني 501 أنه غير مدعوم. لا يعني طلب الإلغاء إلغاء المهمة أو استرداد المبلغ.

المصادقة والصلاحيات

استخدم مفتاح GloopAPI الحالي. تعتمد النماذج والإمكانات والصلاحيات المتاحة على دليله ووثائق نقطة النهاية.

Authorization: Bearer $GLOOP_API_KEY

آليات المصادقة: BearerAuth

الطلب

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

task_idstringمطلوب
المعرّف العام لمهمة أُنشئت بالمفتاح نفسه.

الاستجابات والأخطاء

HTTP 200

نجح الطلب.

application/json

النوع: object
الحقول المطلوبة: idcancel_requested

idstringمطلوب
cancel_requestedbooleanمطلوب
القيم المعدودة
[true]

HTTP 401

Key مفقود أو غير صالح أو منتهي أو ملغى.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (4)
- codestringاختياري
- messagestringاختياري
- typestringاختياري
- request_idstringاختياري

HTTP 403

المفتاح الحالي لا يملك الصلاحية.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (3)
- messagestringمطلوب
- typestringمطلوب
  القيم المعدودة
  ["new_api_error"]
- codestringمطلوب

HTTP 404

الكائن أو الإمكانية غير متاحين.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (3)
- messagestringمطلوب
- typestringمطلوب
  القيم المعدودة
  ["new_api_error"]
- codestringمطلوب

HTTP 409

تعارض في الطلب، أو عدم جاهزية، أو إرسال غير معروف النتيجة. استعلم عن السجل الأصلي أولًا؛ ولا تُعِد الإرسال دون تحقق.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (3)
- messagestringمطلوب
- typestringمطلوب
  القيم المعدودة
  ["new_api_error"]
- codestringمطلوب

HTTP 429

حد معدل الطلبات/قائمة الانتظار.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (4)
- codestringاختياري
- messagestringاختياري
- typestringاختياري
- request_idstringاختياري

HTTP 500

فشل داخلي في المصادقة أو تخزين البيانات.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (4)
- codestringاختياري
- messagestringاختياري
- typestringاختياري
- request_idstringاختياري

HTTP 501

نموذج الفيديو المختار لا يدعم الإلغاء (cancel_unsupported)؛ ولا يعني ذلك أن المبلغ قد استُرد.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (4)
- codestringاختياري
- messagestringاختياري
- typestringاختياري
- request_idstringاختياري

HTTP 502

خطأ في استجابة الخدمة.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (3)
- messagestringمطلوب
- typestringمطلوب
  القيم المعدودة
  ["new_api_error"]
- codestringمطلوب

HTTP 503

الخدمة أو التخزين أو التسعير غير متاحة مؤقتًا.

application/json

النوع: object
الحقول المطلوبة: error

errorobjectمطلوب
الحقول الفرعية لـ error (3)
- messagestringمطلوب
- typestringمطلوب
  القيم المعدودة
  ["new_api_error"]
- codestringمطلوب