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": "abc"
}
输出示例
{
"Response": {
"TrainingTaskDetail": {
"Id": "abc",
"Name": "abc",
"Uin": "abc",
"SubUin": "abc",
"Region": "abc",
"FrameworkName": "abc",
"FrameworkVersion": "abc",
"FrameworkEnvironment": "abc",
"ChargeType": "abc",
"ResourceGroupId": "abc",
"ResourceConfigInfos": [
{
"Role": "abc",
"Cpu": 1,
"Memory": 1,
"GpuType": "abc",
"Gpu": 1,
"InstanceType": "abc",
"InstanceNum": 1,
"InstanceTypeAlias": "abc",
"RDMAConfig": {
"Enable": true
}
}
],
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"TrainingMode": "abc",
"CodePackagePath": {
"Bucket": "abc",
"Region": "abc",
"Paths": [
"abc"
]
},
"StartCmdInfo": {
"StartCmd": "abc",
"PsStartCmd": "abc",
"WorkerStartCmd": "abc"
},
"DataSource": "abc",
"DataConfigs": [
{
"MappingPath": "abc",
"DataSourceType": "abc",
"DataSetSource": {
"Id": "abc"
},
"COSSource": {
"Bucket": "abc",
"Region": "abc",
"Paths": [
"abc"
]
},
"CFSSource": {
"Id": "abc",
"Path": "abc",
"MountType": "abc",
"Protocol": "abc"
},
"HDFSSource": {
"Id": "abc",
"Path": "abc"
},
"GooseFSSource": {
"Id": "abc"
},
"CFSTurboSource": {
"Id": "abc",
"Path": "abc"
}
}
],
"TuningParameters": "abc",
"Output": {
"Bucket": "abc",
"Region": "abc",
"Paths": [
"abc"
]
},
"LogEnable": true,
"LogConfig": {
"LogsetId": "abc",
"TopicId": "abc"
},
"VpcId": "abc",
"SubnetId": "abc",
"ImageInfo": {
"ImageType": "abc",
"ImageUrl": "abc",
"RegistryRegion": "abc",
"RegistryId": "abc",
"AllowSaveAllContent": true,
"ImageName": "abc"
},
"RuntimeInSeconds": 1,
"CreateTime": "abc",
"StartTime": "abc",
"ChargeStatus": "abc",
"LatestInstanceId": "abc",
"TensorBoardId": "abc",
"Remark": "abc",
"FailureReason": "abc",
"UpdateTime": "abc",
"EndTime": "abc",
"BillingInfo": "abc",
"ResourceGroupName": "abc",
"Message": "abc",
"Status": "abc",
"CallbackUrl": "abc"
},
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.QueryResourceGroupNamesFailed | 查询资源组名称失败。 |
InternalError.NoPermission | 没有权限。 |
InternalError.QueryBindingTagsFailed | 查询标签失败。 |
InternalError.QueryResourceGroupNamesFailed | 查询预付费资源组名称失败 |
ResourceNotFound | 资源不存在。 |