1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
查询训练任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTrainingJob。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TrainingJobName | 是 | String | 训练任务名称 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AlgorithmSpecification | AlgorithmSpecification | 算法镜像配置 |
TrainingJobName | String | 任务名称 |
HyperParameters | String | 算法超级参数 注意:此字段可能返回 null,表示取不到有效值。 |
InputDataConfig | Array of InputDataConfig | 输入数据配置 |
OutputDataConfig | OutputDataConfig | 输出数据配置 |
StoppingCondition | StoppingCondition | 中止条件 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceConfig | ResourceConfig | 计算实例配置 |
VpcConfig | VpcConfig | 私有网络配置 注意:此字段可能返回 null,表示取不到有效值。 |
FailureReason | String | 失败原因 注意:此字段可能返回 null,表示取不到有效值。 |
LastModifiedTime | Timestamp | 最近修改时间 |
TrainingStartTime | Timestamp | 任务开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
TrainingEndTime | Timestamp | 任务完成时间 注意:此字段可能返回 null,表示取不到有效值。 |
ModelArtifacts | ModelArtifacts | 模型输出配置 注意:此字段可能返回 null,表示取不到有效值。 |
SecondaryStatus | String | 详细状态,取值范围 Starting:启动中 Downloading: 准备训练数据 Training: 正在训练 Uploading: 上传训练结果 Completed:已完成 Failed: 失败 MaxRuntimeExceeded: 任务超过最大运行时间 Stopping: 停止中 Stopped:已停止 |
SecondaryStatusTransitions | Array of SecondaryStatusTransition | 详细状态事件记录 注意:此字段可能返回 null,表示取不到有效值。 |
RoleName | String | 角色名称 注意:此字段可能返回 null,表示取不到有效值。 |
TrainingJobStatus | String | 训练任务状态,取值范围 InProgress:运行中 Completed: 已完成 Failed: 失败 Stopping: 停止中 Stopped:已停止 |
LogUrl | String | 训练任务日志链接 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceId | String | 训练任务实例ID |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询训练任务
输入示例
https://tione.tencentcloudapi.com/?Action=DescribeTrainingJob
&TrainingJobName=api_test
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "9f91ba5c-03bb-4c02-b9cc-d2740821112f",
"TrainingJobName": "api_test",
"AlgorithmSpecification": {
"AlgorithmName": null,
"TrainingImageName": "ccr.ccs.tencentyun.com/ti_public/tensorflow:1.14.0-py3",
"TrainingInputMode": "File"
},
"HyperParameters": "{\"b\":2}",
"InputDataConfig": [
{
"ChannelName": "training",
"ContentType": null,
"DataSource": null,
"InputMode": null
}
],
"OutputDataConfig": {
"CosOutputBucket": "ti-ap-guangzhou-100005457260-1256633383",
"CosOutputKeyPrefix": ""
},
"StoppingCondition": {
"MaxRuntimeInSeconds": 86400
},
"ResourceConfig": {
"InstanceCount": 1,
"InstanceType": "TI.SMALL2.1core2g",
"VolumeSizeInGB": 10
},
"VpcConfig": null,
"RoleName": "role_name",
"FailureReason": "create training job failure",
"LastModifiedTime": "2019-11-22 11:57:52",
"TrainingStartTime": null,
"TrainingEndTime": null,
"ModelArtifacts": null,
"TrainingJobStatus": "Failed",
"SecondaryStatus": "Failed",
"SecondaryStatusTransitions": [
{
"StartTime": "2019-11-22 11:09:52",
"EndTime": "2019-11-22 11:11:34",
"Status": "Starting",
"StatusMessage": "Launching ML instance"
},
{
"StartTime": "2019-11-22 11:11:34",
"EndTime": "2019-11-22 11:11:36",
"Status": "Starting",
"StatusMessage": "ML instance ready"
},
{
"StartTime": "2019-11-22 11:11:36",
"EndTime": "2019-11-22 11:11:37",
"Status": "Downloading",
"StatusMessage": "Training data ready"
},
{
"StartTime": "2019-11-22 11:11:37",
"EndTime": null,
"Status": "Failed",
"StatusMessage": "create training job failure"
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |