> ## Documentation Index
> Fetch the complete documentation index at: https://ppio.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 取消批处理任务

## 请求头

<ParamField header="Content-Type" type="string" required={true}>
  枚举值: `application/json`
</ParamField>

<ParamField header="Authorization" type="string" required={true}>
  Bearer 身份验证格式，例如：Bearer \{\{API 密钥}}。
</ParamField>

## 路径参数

<ParamField path="batch_id" type="string" required={true}>
  要取消的批处理任务唯一标识符。
</ParamField>

## 响应

<ResponseField name="id" type="string" required={true}>
  批处理任务的唯一标识符。
</ResponseField>

<ResponseField name="object" type="string" required={true}>
  对象类型，恒为 `batch`。
</ResponseField>

<ResponseField name="endpoint" type="string" required={true}>
  批处理任务用于处理请求的 API 端点。
</ResponseField>

<ResponseField name="input_file_id" type="string" required={true}>
  包含批处理请求的输入文件 ID。
</ResponseField>

<ResponseField name="output_file_id" type="string" required={true}>
  包含批处理结果的输出文件 ID。在批处理完成之前为空。
</ResponseField>

<ResponseField name="error_file_id" type="string" required={true}>
  包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。
</ResponseField>

<ResponseField name="completion_window" type="string" required={true}>
  批处理完成的时间窗口。当前固定为 `48h`。
</ResponseField>

<ResponseField name="in_progress_at" type="string | null" required={false}>
  批处理开始处理的时间戳。若尚未开始则为 null。
</ResponseField>

<ResponseField name="expires_at" type="string | null" required={false}>
  批处理到期的时间戳。若未设置则为 null。
</ResponseField>

<ResponseField name="finalizing_at" type="string | null" required={false}>
  批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。
</ResponseField>

<ResponseField name="completed_at" type="string | null" required={false}>
  批处理完成的时间戳。若尚未完成则为 null。
</ResponseField>

<ResponseField name="failed_at" type="string | null" required={false}>
  批处理失败的时间戳。若未失败则为 null。
</ResponseField>

<ResponseField name="expired_at" type="string | null" required={false}>
  批处理过期的时间戳。若未过期则为 null。
</ResponseField>

<ResponseField name="cancelling_at" type="string | null" required={false}>
  批处理开始取消的时间戳。若未在取消中则为 null。
</ResponseField>

<ResponseField name="cancelled_at" type="string | null" required={false}>
  批处理被取消的时间戳。若未被取消则为 null。
</ResponseField>

<ResponseField name="status" type="string" required={true}>
  批处理任务的当前状态。

  可用状态：

  * `VALIDATING` - 在批处理开始前正在验证输入文件
  * `PROGRESS` - 批处理进行中
  * `COMPLETED` - 批处理成功完成
  * `FAILED` - 批处理失败
  * `EXPIRED` - 批处理超过截止时间
  * `CANCELLING` - 正在取消批处理
  * `CANCELLED` - 批处理已取消
</ResponseField>

<ResponseField name="errors" type="string" required={false}>
  批处理过程中发生错误时的错误信息。
</ResponseField>

<ResponseField name="version" type="integer" required={true}>
  批处理任务的版本号。
</ResponseField>

<ResponseField name="created_at" type="string" required={true}>
  批处理任务的创建时间戳。
</ResponseField>

<ResponseField name="updated_at" type="string | null" required={false}>
  批处理任务最近一次更新的时间戳。若从未更新则为 null。
</ResponseField>

<ResponseField name="created_by" type="string" required={true}>
  创建该批处理任务的用户唯一标识符。
</ResponseField>

<ResponseField name="created_by_key_id" type="string" required={true}>
  用于创建该批处理任务的 API Key ID。
</ResponseField>

<ResponseField name="remark" type="string" required={false}>
  批处理任务的可选备注信息。
</ResponseField>

<ResponseField name="total" type="integer" required={true}>
  批处理中的请求总数。
</ResponseField>

<ResponseField name="completed" type="integer" required={true}>
  批处理中已完成的请求数量。
</ResponseField>

<ResponseField name="failed" type="integer" required={true}>
  批处理中失败的请求数量。
</ResponseField>

<ResponseField name="metadata" type="object | null" required={false}>
  与批处理任务关联的附加元数据。若无则为 null。
</ResponseField>

<ResponseField name="request_counts" type="object" required={true}>
  请求计数的详细信息。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="total" type="integer" required={true}>
      批处理中的请求总数。
    </ResponseField>

    <ResponseField name="completed" type="integer" required={true}>
      成功完成的请求数量。
    </ResponseField>

    <ResponseField name="failed" type="integer" required={true}>
      失败的请求数量。
    </ResponseField>
  </Expandable>
</ResponseField>
