1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询目录树
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDsFolderTree。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目id 示例值：1460947878944567296 |
| FirstLevelPull | 否 | Boolean | 是否一级拉取 true 是 false 否 示例值：false |
| FolderId | 否 | String | 文件夹ID 示例值：860a23d6-ea4a-11ed-8909-bc97e105ba60 |
| WorkflowId | 否 | String | 工作流ID 示例值：860a23d6-ea4a-11ed-8909-bc97e105baop |
| Keyword | 否 | String | 关键字搜索 示例值：wedata |
| IncludeWorkflow | 否 | Boolean | 是否包含工作流 true 是 false 否 示例值：false |
| IncludeTask | 否 | Boolean | 是否包含任务 true 是 false 否 示例值：false |
| IncludeVirtualTask | 否 | Boolean | 是否包含虚拟任务，当 IncludeTask 为 true 的时候，该参数才生效，默认为 true 示例值：false |
| TaskFolderId | 否 | String | 任务目录id 示例值：8cc31ac0-ea4a-11ed-8909-bc97e105ba60 |
| DisplayType | 否 | String | classification.分类展示 catalog.目录展示 示例值：classification |
| IncludeTaskFolder | 否 | Boolean | 是否包含任务目录 true 是 false 否 示例值：false |
| NewFolderTreeMode | 否 | Boolean | 是否使用最新模式展示目录树 示例值：false |
| TaskNodeId | 否 | String | 节点分类ID 示例值：aaa_DLC |
| WorkflowType | 否 | String | 工作流类型, 使用场景: 任务复制,选择工作流. 取值范围 - cycle 周期工作流 - manual 手动工作流 示例值：cycle |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of PathNodeDsVO | 统一树结构返回属性列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询目录树
查询目录树，展开目录树
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDsFolderTree
<公共请求参数>
{
"ProjectId": "1485413914375667733",
"FirstLevelPull": true,
"FolderId": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"WorkflowId": "11265328-2c7d-11ee-8d13-a4ae120f8273",
"Keyword": "demoKey",
"IncludeWorkflow": true,
"IncludeTask": true
}输出示例
{
"Response": {
"Data": [
{
"Children": [
{
"Children": [],
"Id": "156b3b03-2c7d-11ee-8d13-a4ae120f8272",
"IsLeaf": false,
"Params": "eyJzdWJtaXRGbGFnIjp0cnVlLCJvd25lcklkIjoiMTAwMDI5NDExMDU2Iiwid29ya2Zsb3dEZXNjIjoiIn0=",
"ParentId": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"Title": "f1332",
"Type": "workflow"
},
{
"Children": [],
"Id": "2f03778a-2c7d-11ee-8d13-a4ae120f8272",
"IsLeaf": false,
"Params": "eyJzdWJtaXRGbGFnIjp0cnVlLCJvd25lcklkIjoiMTAwMDI5NDExMDU2Iiwid29ya2Zsb3dEZXNjIjoiIn0=",
"ParentId": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"Title": "f2",
"Type": "workflow"
}
],
"Id": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"IsLeaf": false,
"Params": null,
"ParentId": "",
"Title": "0_dengboxu",
"Type": "folder"
}
],
"RequestId": "de4d6055-1501-46e4-86d3-7b6e47c5b8d5"
}
}示例2 错误示例
错误示例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDsFolderTree
<公共请求参数>
{
"ProjectId": "2224252741354745856"
}输出示例
{
"Response": {
"Error": {
"Code": "UnauthorizedOperation",
"Message": "当前用户角色或WeData版本没有权限，请进行角色授权或者升级WeData版本"
},
"RequestId": "78deafe3-7320-448e-a6a5-2fcb38a4e4a5"
}
}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
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
