停止一個尚未完成的大量任務。尚未開始的項目會被取消;已在執行中的項目則允許完成。
cancelBulkOperation 會停止你提交的任務。此操作是盡力而為且不可逆:仍為 QUEUED 的項目會被取消,而已在 RUNNING 的項目則允許完成並記錄其結果。它不會回滾已經完成的工作。
要求
Authorization: Basic <API_KEY>- 你的應用程式已啟用大量 API 能力。
- 任務必須屬於你的應用程式——未知或屬於其他應用程式的任務 ID 會回傳 not-found。
Mutation
回應
參數
回應欄位
錯誤
取消已完成或已取消的任務不是錯誤——會回傳未變更的任務(見下文)。
取消是冪等且可安全重試。對已完成(
COMPLETED、COMPLETED_WITH_ERRORS、FAILED)或已 CANCELLED 的任務呼叫此操作,會回傳未變更的任務——永不產生錯誤,且不會回復已完成的項目。由於執行中的項目允許完成,若在取消後需要最終結算的計數,請使用 追蹤大量任務 來輪詢任務。