POST https://ark.cn-beijing.volcengineapi.com/?Action=GetBatchInferenceJob&Version=2024-01-01
获取批量推理任务的详细信息,包括任务状态、模型引用、请求计数等。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 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 格式。