大数据智能体工作台 DataBuddy 更新代码文件

1. 接口描述

接口请求域名： databuddy.tencentcloudapi.com 。

更新文件内容与运行配置（计算资源、默认 catalog/schema、参数等），返回更新后的文件元信息。

前置条件

FileId 对应文件必须存在且为活跃状态；
调用方对该文件有写权限；
仅更新配置时不传 Storage；仅更新内容时不传 FileConfig；
FileConfig.ResourceId 非空时会校验资源类型与文件类型的匹配性。

错误码（Module 均为 Studio）

错误码（Code）	InnerCode	描述	处理建议
`MissingParameter.WorkspaceId`	1030001	缺少 WorkspaceId	请传入 WorkspaceId
`MissingParameter.FileId`	1030003	缺少 FileId	请传入 FileId
`InvalidParameterValue.FileType`	1030102	FileType 取值不支持	FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE
`InvalidParameterValue.ResourceId`	1030104	计算资源类型与文件类型不匹配	Python/Notebook 选数据计算资源，SQL 选数据分析资源
`ResourceNotFound.FileNotFound`	1030203	文件不存在或已删除	请确认 FileId，或调用 GetFile 校验文件状态
`UnauthorizedOperation.FileWriteDenied`	1030302	对该文件无写权限	请联系文件负责人或空间管理员授权
`FailedOperation.FileStorageUpdateFailed`	1030401	文件内容写入存储失败	请稍后重试，持续失败请携带 RequestId 联系支持
`InternalError`	1030900	服务内部异常	请携带 RequestId 联系支持

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpdateFile。
Version	是	String	公共参数，本接口取值：2026-07-15。
Region	是	String	公共参数，详见产品支持的地域列表。
WorkspaceId	是	String	工作空间 ID。来源：ListWorkspaces 接口返回的 WorkspaceId 示例值：17676920188276733
FileId	是	String	文件 ID。来源：CreateFile / ListFiles / GetFile 接口返回的 FileId 示例值：872597305364471808
FileConfig	否	FileConfig	文件运行配置。不传则不更新配置
FileType	否	String	文件类型。取值：FILE（普通文件/脚本）、NOTEBOOK_FILE（Notebook）、SQL_FILE（SQL文件）。对应 common/domain/entity.proto EntityType 示例值：NOTEBOOK_FILE
BundleId	否	String	绑定的 BundleId。来源：ListBundles 接口返回的 BundleId 示例值：create_test
BundleInfo	否	String	绑定的 BundleInfo，JSON 字符串示例值：{'key1': 'value1'}
Storage	否	FileStorage	文件内容。不传则不更新内容
FileName	否	String	目标文件名，非空且与当前文件名不同时执行 rename 动作。长度不超过 SCRIPT_NAME_MAX_LENGTH，禁止以 . 或 .. 开头/结尾，禁止空格、双点、控制字符及 Linux 保留名（参考 docs/linux_filename_rules.md）。与 ExtensionType 一起校验后缀合法性示例值：create_by_api3.ipynb
ParentFolderPath	否	String	目标父目录路径，非空时执行 move 动作。根目录传 /；与 FileName 可同时出现，语义为「移动+重命名」。与 CreateFile 的 ParentFolderPath 保持一致示例值：/Workspace/Users
TargetFileType	否	String	目标父目录的 FileType。取值：FOLDER、GIT_FOLDER。仅当 ParentFolderPath 非空时使用；缺省时按解析出的父目录实际类型处理示例值：FOLDER
UpdateAction	否	Integer	动作类型（必填，未来版本会强制校验）。取值：1 = UPDATE_CONTENT（仅更新 FileConfig / Storage / Bundle，禁止传 FileName / ParentFolderPath / TargetFileType）；2 = RENAME（仅重命名，必须传 FileName，禁止传 ParentFolderPath / FileConfig / Storage / Bundle）；3 = MOVE（仅移动，必须传 ParentFolderPath，禁止传 FileName / FileConfig / Storage / Bundle*）。参数互斥校验失败会返回 ParamIllegal 错误示例值：1

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: UpdateFile
<公共请求参数>

{
    "WorkspaceId": "17676920188276733",
    "FileId": "872597305364471808",
    "FileType": "NOTEBOOK_FILE",
    "BundleId": "create_test",
    "BundleInfo": "{'key1': 'value1'}",
    "Storage": {
        "StorageType": 1,
        "Content": "ewogICJjZWxscyI6IFsKICAgIHsKICAgICAgImNlbGxfdHlwZSI6ICJjb2RlIiwKICAgICAgImV4ZWN1dGlvbl9jb3VudCI6IG51bGwsCiAgICAgICJtZXRhZGF0YSI6IHt9LAogICAgICAib3V0cHV0cyI6IFtdLAogICAgICAic291cmNlIjogWwogICAgICAgICJwcmludCgxKSIKICAgICAgXSwKICAgICAgImlkIjogImNlbGwtMC0xNzg1ODUxNDg2MTM4IgogICAgfQogIF0sCiAgIm1ldGFkYXRhIjoge30sCiAgIm5iZm9ybWF0IjogNCwKICAibmJmb3JtYXRfbWlub3IiOiA1Cn0="
    }
}

输出示例

{
    "Response": {
        "Data": {
            "AppId": "251436191",
            "BundleId": "create_test",
            "BundleInfo": "{'key1': 'value1'}",
            "CreateTime": "1785851410",
            "CreateUserUin": "700002164618",
            "FileConfig": {
                "AdvanceConfig": "",
                "DefaultCatalog": "",
                "DefaultSchema": "",
                "ExtraParams": "",
                "OutputConf": [],
                "Params": "eyJtbGZsb3dfcHJlX2V4ZWN1dGVfY29zX3BhdGgiOiJodHRwczovL2J1Y2tldC0zMC0yNTE0MzYxOTEuY29zLmFwLWd1YW5nemhvdS5teXFjbG91ZC5jb20vc2NpLzE3Njc2OTIwMTg4Mjc2NzMzL3BlcnNvbmFsLzcwMDAwMjE2NDYxOC84NzI1OTczMDUzNjQ0NzE4MDgvbm90ZWJvb2tfcHJlbG9hZF9zY3JpcHQucHkifQ==",
                "ResourceId": ""
            },
            "FileId": "872597305364471808",
            "FileName": "create_by_api3.ipynb",
            "FileType": "NOTEBOOK_FILE",
            "OwnerUserName": "wedata30-dev@tencent.com",
            "Path": "/Workspace/Users/create_by_api3.ipynb",
            "Permissions": "[MANAGE]",
            "ReleaseStatus": false,
            "ResourceMode": 0,
            "Status": "active",
            "Storage": {
                "Content": "",
                "StoragePath": "",
                "StorageType": 0
            },
            "UpdateTime": "1785851538",
            "UpdateUserUin": "700002164618",
            "WorkspaceId": "17676920188276733"
        },
        "RequestId": "e5e3c887-81f6-45d4-982e-6d43364fe366"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

更新代码文件

本页目录：