1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
用于列出子应用下存储的文件条目。
此API只在“FileID+Path模式”下可用
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListFiles。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SubAppId | 是 | Integer | 点播应用 ID。 示例值:1500035838 |
| Prefix | 否 | String | 对象键匹配前缀,限定响应中只包含指定前缀的对象键。 示例值:dir/ |
| Delimiter | 否 | String | 一个字符的分隔符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中。 示例值:/ |
| MaxKeys | 否 | Integer | ys 单次返回最大的条目数量,默认值为100,最小为1,最大为100。 示例值:10 |
| Marker | 否 | String | 起始对象键标记 示例值:path/a.mp4 |
| Categories.N | 否 | Array of String | 文件类型。匹配集合中的任意元素: 示例值:["Video"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IsTruncated | Boolean | 响应条目是否被截断。 示例值:true |
| NextMarker | String | 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入。 示例值:path/a.mp4 |
| CommonPrefixes | Array of String | 从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分,定义为 Common Prefix。仅当请求中指定了 delimiter 参数才有可能返回该节点。 示例值:["dir1", "dir2"] |
| Contents | Array of FileContent | 对象条目。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出应用下的所有文件
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListFiles
<公共请求参数>
{
"SubAppId": 1500035838
}
输出示例
{
"Response": {
"CommonPrefixes": [],
"Contents": [
{
"Category": "Image",
"ETag": "\"5851a9f53660df65a9848b52fa7f78b0\"",
"FileId": "4424135348382730170",
"FileType": "OriginalFiles",
"Key": "dir2/image.jpg",
"LastModified": "2025-12-09T04:07:58.000Z",
"Size": 648712,
"StorageClass": "STANDARD"
},
{
"Category": "Video",
"ETag": "\"5352725bc44f2b72973fd97d1cf22161\"",
"FileId": "966263618845460745",
"FileType": "OriginalFiles",
"Key": "dir2/video.mp4",
"LastModified": "2025-12-15T04:23:50.000Z",
"Size": 118,
"StorageClass": "STANDARD"
},
{
"Category": "Video",
"ETag": "\"35a4ffd511d3f909ae4011f336836267-1\"",
"FileId": "966263618845458706",
"FileType": "OriginalFiles",
"Key": "video.mp4",
"LastModified": "2025-12-12T07:14:05.000Z",
"Size": 3303699,
"StorageClass": "STANDARD"
}
],
"IsTruncated": false,
"NextMarker": "",
"RequestId": "c4fe6ede-97dd-418d-aaf3-248e30e9bfd0"
}
}
示例2 列出应用的根目录下的文件和文件夹
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListFiles
<公共请求参数>
{
"SubAppId": 1500035838,
"Delimiter": "/"
}
输出示例
{
"Response": {
"CommonPrefixes": [
"dir1/",
"dir2/"
],
"Contents": [
{
"Category": "Video",
"ETag": "\"35a4ffd511d3f909ae4011f336836267-1\"",
"FileId": "966263618845458706",
"FileType": "OriginalFiles",
"Key": "video.mp4",
"LastModified": "2025-12-12T07:14:05.000Z",
"Size": 3303699,
"StorageClass": "STANDARD"
}
],
"IsTruncated": false,
"NextMarker": "",
"RequestId": "c4fe6ede-97dd-418d-aaf3-248e30e9bfd0"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.SubAppId | 参数值错误:应用 ID。 |