帮你快速理解、总结文档立即下载
文档中心>API 中心>大数据智能体工作台 DataBuddy>开发工作台(Studio)相关接口>获取文件夹和文件列表

获取文件夹和文件列表

最近更新时间：2026-09-29 01:53:48
我的收藏

本页目录：

1. 接口描述

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

获取文件夹和文件列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ListFiles。
Version 是 String 公共参数，本接口取值：2026-07-15。
Region 是 String 公共参数，详见产品支持的 地域列表。
WorkspaceId 是 String

工作空间id


示例值：17697**047629
Parent 否 FolderLocator

父目录，不填默认查询根节点
FileTypes.N 否 Array of String

按文件类型过滤


示例值：["FOLDER"]
NameKeyword 否 String

文件名模糊匹配


示例值：071*
OwnerUserUins.N 否 Array of String

按所有者UIN过滤，多值为或关系


示例值：["4611686018428258532"]
OnlyFolder 否 Boolean

是否只列出文件夹，默认 false


示例值：true
OrderBys.N 否 Array of OrderBy

排序字段列表，如创建时间 [{Name: 'CreateTime', Direction: 'DESC'}]，文件名称 [{Name: 'Name', Direction: 'ASC'}]
PageNumber 否 Integer

页码，默认1，最小值1


示例值：1
PageSize 否 Integer

每页条数，默认10，最小值10，最大值100

取值范围：[10, 100]


示例值：100

3. 输出参数

参数名称 类型 描述
Data ListFilesRsp

文件列表结果
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ListFiles

获取文件夹和文件列表

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListFiles
<公共请求参数>

{
    "WorkspaceId": "17697****0**47629",
    "Parent": {
        "FolderId": "86553********46400"
    },
    "NameKeyword": "071*****"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "Creator": {
                        "Nickname": "we***a*************t.com",
                        "UserName": "weda**3**********ent.com",
                        "UserTag": "0",
                        "UserUin": "70*******618"
                    },
                    "DeleteTime": "",
                    "GitConfig": null,
                    "Node": {
                        "AllowActions": [
                            "MANAGE"
                        ],
                        "CreateTime": "1784168588000",
                        "FileId": "865539****5***5136",
                        "FileName": "07161023.ipynb",
                        "FileType": "NOTEBOOK_FILE",
                        "IsFavorite": false,
                        "IsSystemGenerated": false,
                        "PathName": "/Workspace/Users/weda********@tenc***************64618/0716/07161023.ipynb",
                        "UpdateTime": "1784168790000"
                    },
                    "NodeType": "",
                    "OriginPath": "",
                    "Owner": {
                        "Nickname": "",
                        "UserName": "",
                        "UserTag": "",
                        "UserUin": "700*******18"
                    },
                    "Parent": {
                        "AllowActions": [],
                        "CreateTime": "",
                        "FileId": "86553*********6400",
                        "FileName": "",
                        "FileType": "",
                        "IsFavorite": false,
                        "IsSystemGenerated": false,
                        "PathName": "",
                        "UpdateTime": ""
                    }
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1,
            "TotalPageNumber": 1
        },
        "RequestId": "6decf098-7409-4899-8018-a563aa53fa73"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

中国站