1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
将文件移入回收站(软删除),同时清理该文件的版本记录与执行结果快照。
前置条件
- FileId 对应文件必须存在且为活跃状态;
- 调用方对该文件有删除权限;
- 文件未被工作流任务引用。
错误码(Module 均为 Studio)
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|---|---|---|---|
MissingParameter.WorkspaceId |
1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
MissingParameter.FileId |
1030003 | 缺少 FileId | 请传入 FileId |
InvalidParameterValue.FileType |
1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
ResourceNotFound.FileNotFound |
1030203 | 文件不存在或已删除 | 请确认 FileId |
ResourceInUse.FileReferencedByTask |
1030204 | 文件被工作流任务引用,不允许删除 | 请先解除任务引用后再删除 |
UnauthorizedOperation.FileDeleteDenied |
1030303 | 对该文件无删除权限 | 请联系文件负责人或空间管理员授权 |
InternalError |
1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DeleteFile。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| WorkspaceId | 是 | String | 工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId 示例值:17678671667189298 |
| FileId | 是 | String | 文件 ID。来源:CreateFile / ListFiles / GetFile 接口返回的 FileId 示例值:878246303882788864 |
| FileType | 否 | String | 文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType 示例值:NOTEBOOK_FILE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DeleteFileResult | 返回结果 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除文件示例
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteFile
<公共请求参数>
{
"WorkspaceId": "17678671667189298",
"FileId": "878246303882788864",
"FileType": "NOTEBOOK_FILE"
}
输出示例
{
"Response": {
"Data": null,
"RequestId": "69bfd283-9bc7-4a0b-a9e8-bbd07f369eea"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。