跳转到主要内容
POST
取消批处理任务
取消一个正在进行的批处理任务。取消后,任务状态将先变为 cancelling,最终变为 cancelled。仅 validatingin_progressfinalizing 状态的任务可以取消。
调用成功后,接口返回一个 BatchObject 对象,包含以下字段:
validatingin_progressfinalizing 状态的任务可以取消。若任务已处于 completedfailedexpiredcancelled 状态,调用此接口将返回 400 错误。
常见错误说明
  • 400 请求错误:任务状态不允许取消,或请求参数无效。请确认任务状态后再发起取消。
  • 401 未授权:API Key 无效或缺失。请检查 Authorization: Bearer <key> 是否正确。
  • 404 未找到:指定的 batch_id 不存在。请确认 ID 拼写正确且该任务属于当前组织。
  • 500 服务器错误:服务端内部错误,请稍后重试;若持续出现,请附带 request_id 联系支持团队。
详见 常见错误码说明
完整的调用示例和状态流转说明,请参考 Batch API 指南

授权

Authorization
string
header
必填

Authorization 请求头需要一个 Bearer 令牌。使用 MOONSHOT_API_KEY 作为令牌。这是一个服务端密钥,请在 API 密钥页面 生成。

路径参数

batch_id
string
必填

批处理任务的 ID

响应

已取消的批处理任务

id
string
必填

批处理任务的唯一标识符

object
string
必填

对象类型,固定为 batch

示例:

"batch"

endpoint
string
必填

请求端点

input_file_id
string
必填

输入文件 ID

completion_window
string
必填

任务处理时间窗口

status
enum<string>
必填

当前状态:validating(校验中)、failed(校验失败)、in_progress(执行中)、finalizing(准备结果中)、completed(已完成)、expired(已过期)、cancelling(取消中)、cancelled(已取消)

可用选项:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
created_at
integer
必填

创建时间(Unix 时间戳)

request_counts
object
必填
output_file_id
string | null

处理成功的结果文件 ID

error_file_id
string | null

处理失败的错误文件 ID

in_progress_at
integer | null

开始执行时间(Unix 时间戳)

expires_at
integer | null

过期时间(Unix 时间戳)

finalizing_at
integer | null

开始准备结果的时间(Unix 时间戳)

completed_at
integer | null

完成时间(Unix 时间戳)

failed_at
integer | null

校验失败时间(Unix 时间戳)

cancelling_at
integer | null

发起取消时间(Unix 时间戳)

cancelled_at
integer | null

取消完成时间(Unix 时间戳)

metadata
object | null

自定义元数据