1. 接口描述
接口请求域名： databuddy.tencentcloudapi.com 。
获取文件的元信息，可选包含文件内容，支持按版本读取历史快照。
前置条件
- FileId 与 FilePath 二选一，至少传一个；同时传时以 FileId 为准；
- 对应文件必须存在，且调用方对该文件有读权限；
- 传 VersionId 时该版本必须存在。
错误码（Module 均为 Studio）
| 错误码（Code） | InnerCode | 描述 | 处理建议 |
|---|---|---|---|
MissingParameter.WorkspaceId |
1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
MissingParameter.FileId |
1030003 | FileId 与 FilePath 同时为空 | FileId 与 FilePath 二选一，至少传一个 |
InvalidParameterValue.FileType |
1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
ResourceNotFound.FileNotFound |
1030203 | 文件不存在或已删除 | 请确认 FileId 或 FilePath |
ResourceNotFound.FileVersionNotFound |
1030205 | 指定的文件版本不存在 | 请确认 VersionId，或调用 ListFileVersions 获取 |
UnauthorizedOperation.FileReadDenied |
1030304 | 对该文件无读权限 | 请联系文件负责人或空间管理员授权 |
InternalError |
1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
默认接口请求频率限制：20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetFile。 |
| Version | 是 | String | 公共参数，本接口取值：2026-07-15。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| WorkspaceId | 是 | String | 工作空间 ID。来源：ListWorkspaces 接口返回的 WorkspaceId 示例值：17676920188276733 |
| FileId | 否 | String | 文件 ID。来源：CreateFile / ListFiles 接口返回的 FileId。与 FilePath 二选一 示例值：837014075591299072 |
| FileType | 否 | String | 文件类型。取值：FILE（普通文件/脚本）、NOTEBOOK_FILE（Notebook）、SQL_FILE（SQL文件）。对应 common/domain/entity.proto EntityType 示例值：NOTEBOOK_FILE |
| IncludeContent | 否 | Boolean | 是否返回文件内容。true 时 Storage.Content 返回 base64 内容，默认 false 示例值：false |
| VersionId | 否 | String | 文件版本 ID。来源：ListFileVersions 接口返回的 VersionId。不传则读取最新版本 示例值：872595707510808576 |
| FilePath | 否 | String | 文件完整路径，以 / 开头，如 /etl/daily/demo.ipynb。与 FileId 二选一 示例值：/Workspace/Users/xingyundong@700002355291/abc.ipynb |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | FileInfo | 返回结果 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取文件信息示例
查询文件元信息与内容
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFile
<公共请求参数>
{
"WorkspaceId": "17676920188276733",
"FileId": "837014075591299072",
"FileType": "NOTEBOOK_FILE",
"IncludeContent": false,
"VersionId": "872595707510808576",
"FilePath": "/Workspace/Users/xingyundong@700002355291/abc.ipynb"
}输出示例
{
"Response": {
"Data": {
"AppId": "251436191",
"BundleId": "",
"BundleInfo": "",
"CreateTime": "1777367707",
"CreateUserUin": "700002164618",
"FileConfig": {
"AdvanceConfig": "",
"DefaultCatalog": "",
"DefaultSchema": "",
"ExtraParams": "",
"OutputConf": [],
"Params": "eyJtbGZsb3dfcHJlX2V4ZWN1dGVfY29zX3BhdGgiOiIifQ==",
"ResourceId": ""
},
"FileId": "837014075591299072",
"FileName": "abc.ipynb",
"FileType": "NOTEBOOK_FILE",
"OwnerUserName": "wedata30-dev@tencent.com",
"Path": "/Workspace/Users/xingyundong@700002355291/abc.ipynb",
"Permissions": "[MANAGE]",
"ReleaseStatus": false,
"ResourceMode": 1,
"Status": "active",
"Storage": {
"Content": "",
"StoragePath": "",
"StorageType": 0
},
"UpdateTime": "1785851029",
"UpdateUserUin": "700002164618",
"WorkspaceId": "17676920188276733"
},
"RequestId": "30507de5-777a-48b0-ab08-c86597439dd5"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
