Skip to main content
POST
取消批处理任务

请求头

string
必填
枚举值: application/json
string
必填
Bearer 身份验证格式,例如:Bearer {{API 密钥}}。

路径参数

string
必填
要取消的批处理任务唯一标识符。

响应

string
必填
批处理任务的唯一标识符。
string
必填
对象类型,恒为 batch
string
必填
批处理任务用于处理请求的 API 端点。
string
必填
包含批处理请求的输入文件 ID。
string
必填
包含批处理结果的输出文件 ID。在批处理完成之前为空。
string
必填
包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。
string
必填
批处理完成的时间窗口。当前固定为 48h
string | null
批处理开始处理的时间戳。若尚未开始则为 null。
string | null
批处理到期的时间戳。若未设置则为 null。
string | null
批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。
string | null
批处理完成的时间戳。若尚未完成则为 null。
string | null
批处理失败的时间戳。若未失败则为 null。
string | null
批处理过期的时间戳。若未过期则为 null。
string | null
批处理开始取消的时间戳。若未在取消中则为 null。
string | null
批处理被取消的时间戳。若未被取消则为 null。
string
必填
批处理任务的当前状态。可用状态:
  • VALIDATING - 在批处理开始前正在验证输入文件
  • PROGRESS - 批处理进行中
  • COMPLETED - 批处理成功完成
  • FAILED - 批处理失败
  • EXPIRED - 批处理超过截止时间
  • CANCELLING - 正在取消批处理
  • CANCELLED - 批处理已取消
string
批处理过程中发生错误时的错误信息。
integer
必填
批处理任务的版本号。
string
必填
批处理任务的创建时间戳。
string | null
批处理任务最近一次更新的时间戳。若从未更新则为 null。
string
必填
创建该批处理任务的用户唯一标识符。
string
必填
用于创建该批处理任务的 API Key ID。
string
批处理任务的可选备注信息。
integer
必填
批处理中的请求总数。
integer
必填
批处理中已完成的请求数量。
integer
必填
批处理中失败的请求数量。
object | null
与批处理任务关联的附加元数据。若无则为 null。
object
必填
请求计数的详细信息。
最后修改于 2026年1月12日