首批通过分布式安全可靠测评,为关键业务系统打造
Retrieve batch - 查询 Batch 任务
更新时间:2026-06-04 20:42:39
功能说明
此接口用于查询指定 Batch 任务的状态与文件信息。通过传入 Batch 任务的唯一标识符,可以获取该任务的当前执行状态及相关文件详情。当前仅支持阿里云 qwen 系列模型。
调用说明
接口约束
- 调用者需要拥有 API Key,详情请参见 管理 AI API Key。
请求路径
GET {BASE_URL}/api/v1/batches/{batch_id}
请求头
| 名称 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|
| Authorization | 是 | Bearer {token} | 鉴权信息 |
| Content-Type | 否 | application/json | 请求体格式 |
请求参数
Path 参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| batch_id | string | 是 | batch_abc123 | Batch 任务 ID |
Query 参数
此接口无 Query 参数。
Body 参数
此接口无 Body 参数。
返回结果
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| success | boolean | 请求是否成功 |
| code | string | 返回码 |
| message | string | 返回信息 |
| data | object | 业务返回数据 |
data 字段说明
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | Batch 任务唯一 ID |
| status | string | Batch 任务状态 |
| fileInfo | object | 关联的文件信息 |
请求示例
curl --request GET '{BASE_URL}/api/v1/batches/batch_abc123' \
--header 'Authorization: Bearer {token}'
返回示例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "batch_abc123",
"status": "completed",
"fileInfo": {
"id": "file-xyz789",
"filename": "output.jsonl"
}
}
}