1. 接口描述
接口请求域名： hunyuan.tencentcloudapi.com 。
文件列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：FilesList。 |
| Version | 是 | String | 公共参数，本接口取值：2023-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Offset | 否 | Integer | 分页偏移量。 示例值：0 |
| Limit | 否 | Integer | 每页数量，最大 100。 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 文件数量。 示例值：100 |
| Object | String | 对象类型，始终为 list。 示例值：list |
| Data | Array of FileObject | FileObject 列表。 示例值：[{"id":"file-YbhlphnNEsjRoKTEXukAqNZZ","object":"file","bytes":15877,"created_at":1722325693,"filename":"test.docx","purpose":"file-extract"}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 |
4. 示例
示例1 文件列表。
文件列表。
输入示例
POST / HTTP/1.1
Host: hunyuan.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: FilesList
<公共请求参数>
{
"Offset": 0,
"Limit": 10
}输出示例
{
"Response": {
"RequestId": "c422c508-6d70-4529-83e0-d20ac5125852",
"Total": 10,
"Object": "list",
"Data": [
{
"ID": "file-YbhlphnNEsjRoKTEXukAqNZZ",
"Object": "file",
"Bytes": 422915,
"CreatedAt": 1722513746,
"Filename": "云API产品简介.pdf",
"Purpose": "file-extract"
}
]
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.EngineRequestTimeout | 引擎层请求超时；请稍后重试。 |
| FailedOperation.EngineServerError | 引擎层内部错误；请稍后重试。 |
| FailedOperation.EngineServerLimitExceeded | 引擎层请求超过限额；请稍后重试。 |
| FailedOperation.FreeResourcePackExhausted | 免费资源包余量已用尽，请购买资源包或开通后付费。 |
| FailedOperation.ResourcePackExhausted | 资源包余量已用尽，请购买资源包或开通后付费。 |
| FailedOperation.ServiceNotActivated | 服务未开通，请前往控制台申请试用。 |
| FailedOperation.ServiceStop | 用户主动停服。 |
| FailedOperation.ServiceStopArrears | 欠费停服。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Model | 模型不存在。 |
