POST https://ark.cn-beijing.volcengineapi.com/?Action=GetModelCustomizationJob&Version=2024-01-01
获取模型训练任务信息
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- Access Key 鉴权，请在 Access Key 管理 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
Id string 必选 | 模型调优任务 ID
模型调优任务 ID，格式如 mcj-20240101000000-a1b2c。可通过 ListModelCustomizationJobs 接口获取
响应参数#
BillingMethod string | 计费方式
调优任务的计费方式标识
CreateTime string | 创建时间
模型调优任务创建时间，UTC 时间，遵循 RFC 3339 格式
CustomizationType string | 训练类型
训练类型。取值范围：FinetuneSft、FinetuneLoRA、Pretrain、DPOLoRA、DPO
CustomRLPipelineConfig object | RL 流水线配置
自定义强化学习流水线配置，包含流水线插件、Grader 混合器及 Teacher 配置等
PipelinePlugins object[] | 插件列表
CustomRLPipelineConfig.PipelinePlugins
自定义强化学习流水线的插件列表
Name string | 插件名称
CustomRLPipelineConfig.PipelinePlugins.Name
流水线插件名称
Description string | 插件描述
CustomRLPipelineConfig.PipelinePlugins.Description
流水线插件描述
Embedded object | 内嵌插件
CustomRLPipelineConfig.PipelinePlugins.Embedded
内嵌（Embedded）类型流水线插件的配置
FunctionMeta object | 函数元信息
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionMeta
内嵌插件对应的函数元信息
FunctionIdentifier string | 函数标识
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionMeta.FunctionIdentifier
函数唯一标识
Source string | 函数源
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionMeta.Source
函数源地址或包标识
SourceType string | 源类型
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionMeta.SourceType
函数源类型，例如代码包或镜像
Type string | 函数类型
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionMeta.Type
函数类型标识
FunctionConfig object | 函数配置
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig
内嵌插件对应的函数运行配置
CpuMilli integer | CPU 配额
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.CpuMilli
函数 CPU 配额，单位毫核（mCPU）
EnvVars object[] | 环境变量
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.EnvVars
函数运行时的环境变量键值对列表
Key string | 环境变量名
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.EnvVars.Key
Value string | 环境变量值
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.EnvVars.Value
MaxConcurrency integer | 最大并发
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.MaxConcurrency
函数允许的最大并发数
MaxReplica integer | 最大副本
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.MaxReplica
函数最大副本数
MemoryMB integer | 内存配额
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.MemoryMB
函数内存配额，单位 MB
MinReplica integer | 最小副本
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.MinReplica
函数最小副本数
RequestConcurrency integer | 单实例并发
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.RequestConcurrency
函数单实例并发请求数
RequestTimeoutSeconds integer | 请求超时
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.RequestTimeoutSeconds
单次函数请求超时时长，单位秒
Runtime string | 运行时
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.Runtime
函数运行时类型标识
Tags object[] | 标签列表
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.Tags
函数关联的标签列表
Key string | 标签键
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.Tags.Key
Value string | 标签值
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.Tags.Value
Weight number | 流量权重
CustomRLPipelineConfig.PipelinePlugins.Embedded.FunctionConfig.Weight
函数流量分配权重
Managed object | 托管插件
CustomRLPipelineConfig.PipelinePlugins.Managed
托管（Managed）类型流水线插件的配置
SID string | 插件 SID
CustomRLPipelineConfig.PipelinePlugins.Managed.SID
托管插件的 SID 标识
FunctionConfig object | 函数配置
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig
托管插件对应的函数运行配置
CpuMilli integer | CPU 配额
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.CpuMilli
函数 CPU 配额，单位毫核（mCPU）
EnvVars object[] | 环境变量
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.EnvVars
函数运行时的环境变量键值对列表
Key string | 环境变量名
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.EnvVars.Key
Value string | 环境变量值
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.EnvVars.Value
MaxConcurrency integer | 最大并发
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.MaxConcurrency
函数允许的最大并发数
MaxReplica integer | 最大副本
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.MaxReplica
函数最大副本数
MemoryMB integer | 内存配额
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.MemoryMB
函数内存配额，单位 MB
MinReplica integer | 最小副本
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.MinReplica
函数最小副本数
RequestConcurrency integer | 单实例并发
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.RequestConcurrency
函数单实例并发请求数
RequestTimeoutSeconds integer | 请求超时
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.RequestTimeoutSeconds
单次函数请求超时时长，单位秒
Runtime string | 运行时
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.Runtime
函数运行时类型标识
Tags object[] | 标签列表
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.Tags
函数关联的标签列表
Key string | 标签键
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.Tags.Key
Value string | 标签值
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.Tags.Value
Weight number | 流量权重
CustomRLPipelineConfig.PipelinePlugins.Managed.FunctionConfig.Weight
函数流量分配权重
Tags object[] | 标签列表
CustomRLPipelineConfig.PipelinePlugins.Tags
流水线插件关联的标签列表
Key string | 标签键
CustomRLPipelineConfig.PipelinePlugins.Tags.Key
Value string | 标签值
CustomRLPipelineConfig.PipelinePlugins.Tags.Value
GraderMixer string | 评分混合
CustomRLPipelineConfig.GraderMixer
用于评估的 Grader 混合器配置（字符串形式）
TeacherConfigs string | Teacher 配置
CustomRLPipelineConfig.TeacherConfigs
Teacher 模型配置（字符串形式）
CustomTLSConfig object | 自定义日志
自定义日志投递的火山引擎日志服务（TLS）配置
ProjectID string | TLS 项目 ID
CustomTLSConfig.ProjectID
火山引擎日志服务（TLS）项目 ID
TopicID string | TLS 主题 ID
CustomTLSConfig.TopicID
火山引擎日志服务（TLS）日志主题 ID
Data object | 数据集配置
模型调优使用的数据集配置，包含训练集、验证集及加密相关字段
TrainingSet object | 训练数据集
Data.TrainingSet
训练阶段使用的数据集配置
Datasets object[] | 数据集列表
Data.TrainingSet.Datasets
数据集列表。此字段非空时表示使用数据集数据训练，不可与 TosBucket、TosPaths 同时存在
DatasetId string | 数据集 ID
Data.TrainingSet.Datasets.DatasetId
调优所引用的数据集 ID
DatasetVersionId string | 版本 ID
Data.TrainingSet.Datasets.DatasetVersionId
数据集的具体版本 ID
Multiplier string | 采样倍率
Data.TrainingSet.Datasets.Multiplier
该数据集相对整体训练集的采样倍率
SampleCount number | 样本数
Data.TrainingSet.Datasets.SampleCount
该数据集贡献的采样样本数
PresetData string | 预置数据集名称
Data.TrainingSet.PresetData
预置数据集名称，不填则不使用预置数据集
PresetDataPercentage integer | 预置数据集占比
Data.TrainingSet.PresetDataPercentage
预置数据集使用百分比（0-100），仅在填写 PresetData 时生效
PresetDatasets object[] | 预置数据集列表
Data.TrainingSet.PresetDatasets
预置数据集列表，元素结构见 PresetDataset
DatasetVersionId string | 预置版本 ID
Data.TrainingSet.PresetDatasets.DatasetVersionId
预置数据集的版本 ID
InjectMultiplier string | 混入倍率
Data.TrainingSet.PresetDatasets.InjectMultiplier
预置数据集相对训练集的混入倍率
InjectSampleCount number | 混入样本数
Data.TrainingSet.PresetDatasets.InjectSampleCount
预置数据集混入的样本数
TosBucket string | TOS 桶名
Data.TrainingSet.TosBucket
TOS 桶名，需与 TosPaths 同时存在。此字段非空时表示直接使用 TOS 数据训练，不可与 Datasets 同时存在
TosPaths string[] | TOS 存储路径列表
Data.TrainingSet.TosPaths
TOS 存储路径列表，需与 TosBucket 同时存在。此字段非空时表示直接使用 TOS 数据训练，不可与 Datasets 同时存在
EncryptionKeyringType string | 加密密钥类型
Data.EncryptionKeyringType
数据集加密密钥类型取值范围：ManagedKeyring、CustomKeyring。默认值：ManagedKeyring
KMSTrn string | 加密密钥 TRN
Data.KMSTrn
加密密钥的 TRN，可在 KMS 控制台中获取。EncryptionKeyringType 为 ManagedKeyring（默认）时自动生成且不可填写；为 CustomKeyring 时必填
ValidationPercentage integer | 验证集占比
Data.ValidationPercentage
从训练集划分作为验证集的比例（0-100）
ValidationSet object | 验证数据集
Data.ValidationSet
验证阶段使用的数据集配置
Datasets object[] | 数据集列表
Data.ValidationSet.Datasets
验证数据集列表，元素结构见 DatasetItem
DatasetId string | 数据集 ID
Data.ValidationSet.Datasets.DatasetId
调优所引用的数据集 ID
DatasetVersionId string | 版本 ID
Data.ValidationSet.Datasets.DatasetVersionId
数据集的具体版本 ID
Multiplier string | 采样倍率
Data.ValidationSet.Datasets.Multiplier
该数据集相对整体训练集的采样倍率
SampleCount number | 样本数
Data.ValidationSet.Datasets.SampleCount
该数据集贡献的采样样本数
TosBucket string | TOS 桶名
Data.ValidationSet.TosBucket
TOS 桶名，需与 TosPaths 同时存在。此字段非空时表示直接使用 TOS 数据验证，不可与 Datasets 同时存在
TosPaths string[] | TOS 存储路径列表
Data.ValidationSet.TosPaths
TOS 存储路径列表，需与 TosBucket 同时存在。此字段非空时表示直接使用 TOS 数据验证，不可与 Datasets 同时存在
DebugConfig object | 调试配置
调优任务的调试相关配置
RLDebugConfig object | RL 调试配置
DebugConfig.RLDebugConfig
强化学习调试配置，包含调试用接入点和 API Key
APIKey string | API Key
DebugConfig.RLDebugConfig.APIKey
强化学习调试使用的 API Key
EndpointID string | 调试接入点 ID
DebugConfig.RLDebugConfig.EndpointID
强化学习调试使用的推理接入点 ID
Description string | 任务描述
模型调优任务描述
EnableTrajectory boolean | 是否启用训练轨迹
是否启用训练轨迹（Trajectory）采集与投递
ExplainabilityTLSConfig object | 可解释性日志
训练可解释性数据投递的火山引擎日志服务（TLS）配置
ProjectID string | TLS 项目 ID
ExplainabilityTLSConfig.ProjectID
火山引擎日志服务（TLS）项目 ID
TopicID string | TLS 主题 ID
ExplainabilityTLSConfig.TopicID
火山引擎日志服务（TLS）日志主题 ID
Hyperparameters object[] | 超参数列表
模型调优配置的超参数列表，元素为 Name/Value 键值对
Name string | 超参数名称
Hyperparameters.Name
超参数名称，例如 epoch、learning_rate
Value string | 超参数值
Hyperparameters.Value
超参数取值（字符串形式）
Id string | 任务 ID
模型调优任务资源 ID，格式如 mcj-20240101000000-a1b2c
ModelReference object | 基础模型
模型调优基于的模型，可为基础模型或已有定制模型
CustomModelId string | 自定义模型 ID
ModelReference.CustomModelId
已有定制模型 ID
FoundationModel object | 基础模型引用
ModelReference.FoundationModel
调优基于的基础模型引用
ModelVersion string | 模型版本
ModelReference.FoundationModel.ModelVersion
基础模型版本号
Name string | 模型名称
ModelReference.FoundationModel.Name
基础模型名称，例如 doubao-seed-2-1-pro-260628
Name string | 任务名称
模型调优任务名称
OutputConfig object | 产物输出
调优产物输出相关的配置项
OutputCompressionStrategies string[] | 产物压缩策略
OutputConfig.OutputCompressionStrategies
产物输出时使用的压缩策略列表
Outputs object[] | 产物列表
模型调优产生的检查点（CheckPoint）产物列表，可用于后续模型发布或部署
Index integer | 产物索引
Outputs.Index
产物在该调优任务中的索引序号
Name string | 产物名称
Outputs.Name
调优产物名称，如 global_step_1
Status string | 产物状态
Outputs.Status
调优产物状态。取值范围：Available（可用）、Exported（已发布）、Expired（已过期）
CustomModelCreateTimeUnix number | 模型创建时间
Outputs.CustomModelCreateTimeUnix
定制模型创建时间，Unix 时间戳（秒）
CustomModelId string | 自定义模型 ID
Outputs.CustomModelId
调优产物已发布为定制模型时对应的定制模型 ID
ProjectName string | 所属项目
调优任务所属的火山引擎项目名称
PublishedOutputCount integer | 已发布数
已发布为定制模型的调优产物数量
Reason string | 失败原因
任务失败时的失败原因，取值如 InvalidData、InternalError、UnknownError 等
Resource object | 资源配置
调优任务使用的计算资源规格
Memory integer | 内存大小
Resource.Memory
分配给调优任务的内存大小，单位 MB
VCpu integer | CPU 核数
Resource.VCpu
分配给调优任务的 CPU 核数（vCPU）
GpuNum integer | GPU 数量
Resource.GpuNum
分配给调优任务的 GPU 卡数
RdmaEniCount integer | RDMA 网卡数
Resource.RdmaEniCount
分配给调优任务的 RDMA 弹性网卡数量
VRdmaEniCount integer | 虚拟 RDMA 网卡
Resource.VRdmaEniCount
分配给调优任务的虚拟 RDMA 弹性网卡数量
SaveModelLimit integer | 保存模型上限
调优任务可保存的模型产物数量上限
Status object | 任务状态
模型调优任务的运行状态，包含阶段、耗时、Token 用量等
Phase string | 任务阶段
Status.Phase
调优任务当前所处阶段，例如 Queue、Running、Completed、Failed 等
PhaseTime string | 阶段时间戳
Status.PhaseTime
任务进入当前阶段的时间戳，UTC 时间，遵循 RFC 3339 格式
RetryLimit integer | 最大重试次数
Status.RetryLimit
任务允许的最大重试次数
BillableTokens number | 计费 Token 数
Status.BillableTokens
用于计费的训练 tokens 数量
Message string | 状态说明信息
Status.Message
对当前任务所处状态的解释性信息
OutputExpiredTime string | 产物过期时间
Status.OutputExpiredTime
调优产物（如有）计划过期的时间戳，UTC 时间，遵循 RFC 3339 格式
QueuePosition integer | 队列位次
Status.QueuePosition
排队状态下任务在所属队列中的当前位次
Resumable boolean | 是否可重试
Status.Resumable
任务处于失败状态时，是否可以被重试
RetryCount integer | 已重试次数
Status.RetryCount
任务已经失败重试的次数
TrainingTokensPerEpoch number | 单轮训练 Token 数
Status.TrainingTokensPerEpoch
数据集总 tokens 数，包括训练集、验证集和混入数据
Tags object[] | 标签列表
模型调优任务关联的标签列表，元素为 Key/Value 键值对
Key string | 标签键
Tags.Key
Value string | 标签值
Tags.Value
TotalOutputCount integer | 产物总数
调优任务产生的全部检查点产物总数
TraceTLSConfig object | Trace 日志
训练 Trace 日志投递的火山引擎日志服务（TLS）配置
ProjectID string | TLS 项目 ID
TraceTLSConfig.ProjectID
火山引擎日志服务（TLS）项目 ID
TopicID string | TLS 主题 ID
TraceTLSConfig.TopicID
火山引擎日志服务（TLS）日志主题 ID
TrainingMetrics object[] | 训练指标
训练过程指标列表，元素结构见 Metric
Name string | 指标名称
TrainingMetrics.Name
指标名称，如 train/loss、eval/loss 等
TargetValue integer | 目标值
TrainingMetrics.TargetValue
指标的目标值或参考值
Type string | 类型
TrainingMetrics.Type
指标类型，取值如 External、Pods（默认）
TrainType string | 训练任务类型
训练任务类型标识
TrajectoryTLSConfig object | Trajectory 日志
训练轨迹（Trajectory）日志投递的火山引擎日志服务（TLS）配置
ProjectID string | TLS 项目 ID
TrajectoryTLSConfig.ProjectID
火山引擎日志服务（TLS）项目 ID
TopicID string | TLS 主题 ID
TrajectoryTLSConfig.TopicID
火山引擎日志服务（TLS）日志主题 ID
UpdateTime string | 更新时间
模型调优任务最近一次更新时间，UTC 时间，遵循 RFC 3339 格式
ValidationMetrics object[] | 验证指标
验证过程指标列表，元素结构见 Metric
Name string | 指标名称
ValidationMetrics.Name
指标名称，如 train/loss、eval/loss 等
TargetValue integer | 目标值
ValidationMetrics.TargetValue
指标的目标值或参考值
Type string | 类型
ValidationMetrics.Type
指标类型，取值如 External、Pods（默认）