1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
列出训练实例 Checkpoint 文件列表的响应
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTrainingCheckpoints。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| InstanceId | 否 | String | 训练作业实例ID 示例值:rayjob-20260702201005-qv05 |
| SubPath | 否 | String | 当前浏览的子路径 示例值:sft_ray_training/checkpoint_2026-07-02_17-38-33.912702 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of SharedMountFileItem | 当前层级文件/目录列表 |
| MountPath | String | 当前挂载路径 示例值:/shared |
| SubPath | String | 当前浏览的子路径 示例值:sft_ray_training/checkpoint_2026-07-02_17-38-33.912702/ |
| StorageType | String | 存储类型:COS / CFS / CFS_TURBO / GOOSEFS 示例值:CFS |
| StoragePath | String | 存储路径(COS 桶路径或 CFS/GooseFSx 挂载路径) 示例值:/checkpoints/cus04 |
| Message | String | 错误或提示信息(仅在请求异常时有值) 示例值:实例未配置 Checkpoint 挂载 |
| SnapshotTimestamp | Integer | 快照时间戳(仅 CFS/GooseFSx 存储时有值) 示例值:1783002347 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出训练实例 Checkpoint 文件列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTrainingCheckpoints
<公共请求参数>
{
"InstanceId": "rayjob-20260702201005-qv05",
"SubPath": "sft_ray_training/checkpoint_2026-07-02_17-38-33.912702"
}
输出示例
{
"Response": {
"Items": [
{
"LastModified": 1782984917447,
"Name": "checkpoint.pt",
"Path": "sft_ray_training/checkpoint_2026-07-02_17-38-33.912702/checkpoint.pt",
"Size": 734261,
"Type": "file"
}
],
"MountPath": "/shared",
"SnapshotTimestamp": 1783002347,
"StoragePath": "/checkpoints/cus04",
"StorageType": "CFS",
"SubPath": "sft_ray_training/checkpoint_2026-07-02_17-38-33.912702/",
"RequestId": "efeae2fd-f3f0-4e55-90a7-da88132259e6"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。