1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
获取训练作业配置的列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListTrainingJobSpec。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Page | 否 | Integer | 当前页码,从 1 开始(默认 1) 示例值:1 |
| PageSize | 否 | Integer | 每页数量(默认 200,最大 200) 示例值:10 |
| StartTime | 否 | Integer | 创建时间起始过滤(毫秒时间戳) 单位:ms 示例值:1782891470000 |
| EndTime | 否 | Integer | 创建时间截止过滤(毫秒时间戳) 单位:ms 示例值:1782977870000 |
| Filters.N | 否 | Array of Filter | 过滤条件列表,每项含 Name、Operator、Values。 提交模式过滤:LAB / CUSTOM_CODE / POST_TRAINING。示例:{"Name":"kind","Operator":"EQ","Values":["LAB"]} |
| SortFields.N | 否 | Array of SortField | 排序字段列表,每项含 Field、Order(ASC/DESC)。默认按 updateTime DESC |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of TrainingJobSpec | 训练配置列表信息 |
| Total | Integer | 训练配置总数 示例值:46 |
| Page | Integer | 当前页码,从 1 开始(默认 1) 示例值:1 |
| PageSize | Integer | 每页数量(默认 200,最大 200) 示例值:200 |
| TotalPages | Integer | 总页数 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出训练作业配置
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTrainingJobSpec
<公共请求参数>
{}
输出示例
{
"Response": {
"Items": [
{
"Catalog": "{\"CFSVolumes\":[{\"FileSystemId\":\"cfs-99dt0xbn\",\"VolumeSubPath\":\"/\",\"SubPathMode\":\"subPath\",\"SubPath\":\"checkpoints/cus04\",\"MountPath\":\"/shared\",\"FSId\":null,\"Host\":null,\"PersistVolumeName\":null,\"VpcId\":null,\"SubnetId\":null,\"Uin\":null,\"Region\":null,\"VolumeMountMode\":null,\"Source\":\"checkpoint\",\"AutoCreateSubDir\":true}],\"CFSTurboVolumes\":null,\"COSVolumes\":[{\"Region\":null,\"Bucket\":\"common-job-packages-251233710\",\"VolumeSubPath\":\"/checkpoints/cus_multi_mount_05\",\"SubPathMode\":null,\"SubPath\":null,\"MountPath\":\"/others\",\"PersistVolumeName\":null,\"VolumeMountMode\":null,\"Source\":\"dataset\"}],\"GooseFSVolumes\":null}",
"CheckpointMountInfo": {
"Bucket": "common-job-packages-251233710",
"MountPath": "/shared",
"PlatformManaged": true,
"Region": "ap-guangzhou",
"StorageType": "CFS",
"VolumeSubPath": "/checkpoints/cus04"
},
"CodePackageUrl": "https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260200065/20260630194144/44a9489e-e60d-4d73-a048-8a5fe39b2d32.zip",
"CreateTime": 1782976174590,
"Creator": "700002655693",
"Description": "cus04 test",
"Entrypoint": "bash -c 'cd sft_demo && python -m sft_demo.train_local --storage-path /shared'",
"HasRunningInstances": false,
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-torch-lab",
"InstanceCount": 0,
"Kind": "CUSTOM_CODE",
"Priority": 5,
"Queue": "default",
"ResourceConfig": "{\n \"Head\": {\n \"Name\": \"default-head\",\n \"PodCpu\": 2,\n \"PodMem\": 8,\n \"GpuType\": \"\",\n \"GpuNum\": 0,\n \"Envs\": [],\n \"Labels\": [],\n \"PodNum\": 1,\n \"HighAvailability\": false\n },\n \"Worker\": [\n {\n \"Name\": \"default-worker\",\n \"PodCpu\": 2,\n \"PodMem\": 8,\n \"GpuType\": \"\",\n \"GpuNum\": 0,\n \"Envs\": [],\n \"Labels\": [],\n \"MinPodNum\": 1,\n \"MaxPodNum\": 1\n }\n ]\n}",
"ResourcePartitionId": "dlc-p-wdtiljwu",
"RuntimeEnv": "{\n \"env_vars\": {\n \"LEARNING_RATE\": \"1e-4\",\n \"BATCH_SIZE\": \"32\"\n },\n \"pip\": []\n}",
"SpecId": "raytrain-spec-thjd7y-o9ls",
"SpecName": "cus04",
"UpdateTime": 1782976174590
}
],
"Page": 1,
"PageSize": 200,
"Total": 46,
"TotalPages": 1,
"RequestId": "c8925ed5-50af-44a9-bdc4-89a5dfd423db"
}
}
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.ExternalService | 外部服务异常 |