# 获取批量推理任务
> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。
`POST https://ark.cn-beijing.volcengineapi.com/?Action=GetBatchInferenceJob&Version=2024-01-01`
获取批量推理任务的详细信息，包括任务状态、模型引用、请求计数等。
> **说明**
>
> 任务状态机：`Queued` → `Initializing` → `Running` → `Completed`；运行中可经由 *StopBatchInferenceJob* 进入 `Terminating` → `Terminated`，失败时进入 `Failed`。处于 `Terminated` / `Failed` 状态的任务可通过 *ResumeBatchInferenceJob* 重启。
## 鉴权
本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。
* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。
---
## 请求参数
### Body 参数
**Id** `string` `必选` | 任务 ID
批量推理任务的 ID。
## 响应参数
**CompletionWindow** `string` | 最大等待时间
批量推理任务的最大等待时间。
**CreateTime** `string` | 创建时间
批量推理任务创建时间，RFC 3339 格式。
**Description** `string` | 任务描述
批量推理任务的描述信息。
**ErrorFileTosLocation** `object` | 错误信息文件
任务执行过程中错误信息的输出 TOS 位置。
**BucketName** `string` | TOS 桶名称
`ErrorFileTosLocation.BucketName`
TOS 桶名称。当前火山方舟仅支持华北 2-北京地域（`cn-beijing`）的 TOS 桶。
**ObjectKey** `string` | 对象路径
`ErrorFileTosLocation.ObjectKey`
TOS 对象路径。输入为 JSONL 文件的完整 object key；输出文件夹路径建议以 `/` 结尾。
**ExpireTime** `string` | 到期时间
批量推理任务到期时间，RFC 3339 格式。
**Id** `string` | 任务 ID
批量推理任务的唯一 ID。
**InputFileTosLocation** `object` | 输入文件
批量推理输入文件的 TOS 位置。
**BucketName** `string` | TOS 桶名称
`InputFileTosLocation.BucketName`
TOS 桶名称。当前火山方舟仅支持华北 2-北京地域（`cn-beijing`）的 TOS 桶。
**ObjectKey** `string` | 对象路径
`InputFileTosLocation.ObjectKey`
TOS 对象路径。输入为 JSONL 文件的完整 object key；输出文件夹路径建议以 `/` 结尾。
**ModelReference** `object` | 模型引用
批量推理任务选中的模型。
**CustomModelId** `string` | 定制模型 ID
`ModelReference.CustomModelId`
定制模型 ID。与 *FoundationModel* 二选一，仅需指定其一。
**FoundationModel** `object` | 基础模型引用
`ModelReference.FoundationModel`
基础模型引用对象。与 *CustomModelId* 二选一，仅需指定其一。
**ModelVersion** `string` | 模型版本
`ModelReference.FoundationModel.ModelVersion`
基础模型版本号，例如 `240615`。
**Name** `string` | 模型名称
`ModelReference.FoundationModel.Name`
基础模型名称，例如 `doubao-seed-2-1-pro-260628`。
**Name** `string` | 任务名称
批量推理任务名称。
**OutputDirTosLocation** `object` | 输出文件夹
批量推理任务结果输出的 TOS 文件夹位置。
**BucketName** `string` | TOS 桶名称
`OutputDirTosLocation.BucketName`
TOS 桶名称。当前火山方舟仅支持华北 2-北京地域（`cn-beijing`）的 TOS 桶。
**ObjectKey** `string` | 对象路径
`OutputDirTosLocation.ObjectKey`
TOS 对象路径。输入为 JSONL 文件的完整 object key；输出文件夹路径建议以 `/` 结尾。
**ProjectName** `string` | 项目名称
资源所属的项目名称。
**RequestCounts** `object` | 请求数量
批量推理任务的请求数量统计。
**Completed** `number` | 完成数
`RequestCounts.Completed`
已成功完成的请求数。
**Failed** `number` | 失败数
`RequestCounts.Failed`
失败的请求数。
**Total** `number` | 请求总数
`RequestCounts.Total`
任务包含的请求总数。
**Status** `object` | 任务状态
批量推理任务的状态元信息。
**Phase** `string` | 任务状态
`Status.Phase`
批量推理任务当前所处阶段。各状态含义如下：
- `Queued`：排队中，因账号下并发任务数达到上限等原因等待调度。
- `Initializing`：初始化中。
- `Running`：运行中。
- `Terminating`：取消中（到期、系统原因或手动终止触发）。
- `Terminated`：已终止。
- `Completed`：已完成，所有请求均已处理完毕。
- `Failed`：失败，通常由输入文件校验失败等原因导致。
**PhaseTime** `string` | 状态更新时间
`Status.PhaseTime`
当前状态的更新时间，RFC 3339 格式。
**Message** `string` | 状态描述
`Status.Message`
当前状态的描述信息，用于补充说明任务进度或失败原因。
**Tags** `object[]` | 任务标签
批量推理任务绑定的标签列表。
**Key** `string` | 标签键
`Tags.Key`
**Value** `string` | 标签值
`Tags.Value`
**UpdateTime** `string` | 更新时间
批量推理任务最近更新时间，RFC 3339 格式。
## 代码示例
## 默认
### cURL
#### Request
```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=GetBatchInferenceJob&Version=2024-01-01' \
-H 'Content-Type: application/json' \
-H 'X-Date: ' \
-H 'X-Content-Sha256: ' \
-H 'Authorization: HMAC-SHA256 Credential=//cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=' \
-d '{
"Id": "bi-20240918194641-r2nwq"
}
'
```
#### Response
```
{
"ResponseMetadata": {
"RequestId": "2024091910512025A35A851624E45418",
"Action": "GetBatchInferenceJob",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {
"Id": "bi-20240918194641-r2nwq",
"Name": "批量推理任务",
"Description": "这是一个批量推理任务",
"InputFileTosLocation": {
"BucketName": "my-bucket-name",
"ObjectKey": "batch-inference-job/dataset/my-job.jsonl"
},
"OutputDirTosLocation": {
"BucketName": "my-bucket-name",
"ObjectKey": "batch-inference-job/output/"
},
"CompletionWindow": "1d",
"Status": {
"Phase": "Completed",
"PhaseTime": "2024-09-18T11:50:00Z",
"Message": "批量推理任务已完成"
},
"ModelReference": {
"FoundationModel": {
"Name": "doubao-seed-2-0-pro",
"ModelVersion": "260215"
}
},
"RequestCounts": {
"Total": 2,
"Completed": 2,
"Failed": 0
},
"Tags": [
{
"Key": "owner",
"Value": "team-a"
},
{
"Key": "test_key",
"Value": "test_value"
}
],
"ProjectName": "default",
"CreateTime": "2024-09-18T11:46:41Z",
"UpdateTime": "2024-09-18T11:50:00Z",
"ExpireTime": "2024-09-19T11:46:41Z"
}
}
```