取消批次作業 - Fluz

停止尚未完成的批次工作。尚未開始的項目會被取消；已在執行中的項目允許完成。

cancelBulkOperation 會停止你提交的工作。此操作是盡力而為且不可逆：仍為 QUEUED 的項目會被取消，而已在 RUNNING 的項目允許完成並記錄結果。它不會回滾已完成的作業。

目前僅在 staging 可用。

要求

Authorization: Basic <API_KEY>
你的應用程式已啟用批次 API 能力。
該工作必須屬於你的應用程式——未知或屬於其他應用的工作 ID 會回傳 not-found。

變更

mutation CancelBulkOperation($bulkJobId: UUID!) {
  cancelBulkOperation(bulkJobId: $bulkJobId) {
    jobId
    status
    succeededItemCount
    failedItemCount
    skippedItemCount
  }
}

{
  "bulkJobId": "9c1e6f2a-1d4b-4a2e-8f0c-2b7e5a9d1234"
}

回應

{
  "data": {
    "cancelBulkOperation": {
      "jobId": "9c1e6f2a-1d4b-4a2e-8f0c-2b7e5a9d1234",
      "status": "CANCELLED",
      "succeededItemCount": 4,
      "failedItemCount": 0,
      "skippedItemCount": 0
    }
  }
}

參數

Parameter	Type	Description
`bulkJobId`	`UUID!`	`submitBulkOperation` 回傳的工作 ID。

回應欄位

Field	Description
`status`	當工作已停止接受新作業時為 `CANCELLED`。已成功或失敗的項目會保留其結果。
`succeededItemCount` / `failedItemCount` / `skippedItemCount`	最終的每項目計數，包括在取消呼叫生效後仍完成的項目。

錯誤

Error	HTTP	When
`BulkApiAccessDenied`	403	你的應用程式沒有批次 API 能力。
`BulkJobNotFound`	404	工作 ID 不存在，或屬於另一個應用程式（刻意不可區分）。

取消已完成或已取消的工作不是錯誤——會回傳未變更的工作（見下文）。

取消是冪等且可安全重試。對已完成（COMPLETED、COMPLETED_WITH_ERRORS、FAILED）或已 CANCELLED 的工作呼叫此操作，會回傳未變更的工作——不會產生錯誤，也不會回復已完成的項目。由於進行中的項目允許完成，若在取消後需要最終結算的計數，請使用追蹤批次工作輪詢該工作。