1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
训练任务详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTrainingTask。 |
| Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Id | 是 | String | 训练任务ID 示例值:train-123311 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TrainingTaskDetail | TrainingTaskDetail | 训练任务详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 训练任务详情
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTrainingTask
<公共请求参数>
{
"Id": "train-1329791605108055040"
}
输出示例
{
"Response": {
"TrainingTaskDetail": {
"Id": "train-1329791605108055040",
"Name": "initCommand_test",
"Uin": "100031385875",
"SubUin": "100042146752",
"Region": "ap-guangzhou",
"FrameworkName": "PYTORCH",
"FrameworkVersion": "",
"FrameworkEnvironment": "torch1.9-py3.8-cuda11.1-gpu",
"TrainingMode": "DDP",
"ChargeType": "POSTPAID_BY_HOUR",
"ResourceGroupId": "",
"ResourceGroupName": "",
"ResourceConfigInfos": [
{
"Role": "WORKER",
"Cpu": 2000,
"Memory": 2048,
"GpuType": "",
"Gpu": 0,
"InstanceType": "TI.S6.MEDIUM2.POST",
"InstanceTypeAlias": "2C2G",
"InstanceNum": 1,
"RDMAConfig": {
"Enable": false
}
}
],
"Tags": [
{
"TagKey": "qcs:tag:createdBy",
"TagValue": "CAMUser:100042146752:evanxli"
}
],
"ImageInfo": {
"ImageType": "PRE_SET",
"ImageUrl": "tione.tencentcloudcr.com/qcloud-ti-platform/ti-cloud-torch-1.9.0-devel:1.0.9",
"RegistryRegion": "",
"RegistryId": "",
"ImageName": "torch1.9-py3.8-cuda11.1-gpu"
},
"CodePackagePath": {
"Bucket": "",
"Region": "",
"Paths": []
},
"StartCmdInfo": {
"StartCmd": "",
"PsStartCmd": "",
"WorkerStartCmd": "sleep 3600"
},
"DataSource": "",
"DataConfigs": [],
"TuningParameters": "{abc,}",
"Output": {
"Bucket": "",
"Region": "",
"Paths": []
},
"LogEnable": false,
"LogConfig": {
"LogsetId": "",
"TopicId": ""
},
"VpcId": "",
"SubnetId": "",
"Status": "SUCCEED",
"RuntimeInSeconds": 3602,
"CreateTime": "2025-05-28T18:18:33+08",
"UpdateTime": "2025-05-29T14:41:57+08",
"StartTime": "2025-05-29T14:43:53+08",
"EndTime": "2025-05-29T15:43:55+08",
"ChargeStatus": "NOT_BILLING",
"LatestInstanceId": "train-1329791605108055040-a3vq1whfx24g",
"TensorBoardId": "",
"Remark": "",
"FailureReason": "",
"BillingInfo": "",
"Message": "",
"CallbackUrl": "",
"SubUinName": "evanxli",
"CodeRepos": [
{
"Id": "cr-1076157270725717248",
"TargetPath": "/git/data"
}
]
},
"RequestId": "aaa06bff-0a06-4539-9a86-36b2f605d525"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.QueryResourceGroupNamesFailed | 查询资源组名称失败。 |
| InternalError.NoPermission | 没有权限。 |
| InternalError.QueryBindingTagsFailed | 查询标签失败。 |
| InternalError.QueryResourceGroupNamesFailed | 查询预付费资源组名称失败 |
| ResourceNotFound | 资源不存在。 |