1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询父目录下所有子文件夹+工作流
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAllByFolderNew。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Folder | 否 | FolderOpsDto | 文件夹属性 示例值：{"Id":"c789de4f-bcc7-11ed-b7fc-043f72e73c62"} |
| Workflows.N | 否 | Array of WorkflowCanvasOpsDto | 工作流列表 示例值：["WorkflowId":"f47ac10b-58cc-4372-a567-0e02b2c3d479"] |
| TargetFolderId | 否 | String | 目标文件id 示例值："c789de4f-bcc7-11ed-a567-0e02b2c3d479" |
| KeyWords | 否 | String | 关键字 示例值："test_wf" |
| ParentsFolderId | 否 | String | 父文件id 示例值："c789de4f-bcc7-11ed-a567-0e02b2c3d479" |
| IsAddWorkflow | 否 | String | 拉取文件夹列表 示例值："false" |
| TaskStates.N | 否 | Array of String | 任务状态 示例值：[] |
| FindType | 否 | String | 搜索类型 示例值："all" |
| OptType | 否 | String | 访问类型 示例值："" |
| OperatorName | 否 | String | 操作者名称 示例值："tom" |
| OperatorId | 否 | String | 操作者id 示例值："1234" |
| ProjectId | 否 | String | 项目id 示例值："1232324234234" |
| ProjectIdent | 否 | String | 项目标志 示例值："test_pro" |
| ProjectName | 否 | String | 项目名称 示例值："测试项目" |
| PageIndex | 否 | Integer | 索引页码 示例值：1 |
| PageSize | 否 | Integer | 页面大小 示例值：100 |
| Count | 否 | Integer | 数据总数 示例值：250 |
| RequestBaseInfo | 否 | ProjectBaseInfoOpsRequest | 基础请求信息 |
| IsCount | 否 | Boolean | 是否计算总数 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CollectionFolderOpsDto | 结果集 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 测试
测试
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAllByFolderNew
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"Folder": {
"Id": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
"ProjectId": "1460947878944567296"
},
"Workflows": [
{
"WorkflowId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"TargetFolderId": "c123de4f-b127-21cd-b7fc-043f98y73c62",
"FindType": "all",
"KeyWords": "",
"TaskStates": []
}输出示例
{
"Response": {
"Data": {
"TotalCount": 0,
"TotalPage": 0,
"PageCount": 0,
"PageNumber": 0,
"PageSize": 0,
"Items": [
{
"Id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"CreateTime": "2023-03-25 09:06:00",
"Name": "test",
"ProjectId": "1460947878944567296",
"UpdateTime": "2023-03-25 09:06:00",
"ParentsFolderId": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
"Total": 1,
"Workflows": [
{
"WorkflowId": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
"WorkflowDesc": "wf_0",
"WorkflowName": "wf_0",
"FolderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"FolderIds": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"Tasks": [
{
"TaskId": "20230405060708098",
"VirtualTaskId": "",
"VirtualFlag": false,
"TaskName": "task_1",
"WorkflowId": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
"RealWorkflowId": "",
"WorkflowName": "wf_0 ",
"FolderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479 ",
"FolderName": "test_dir",
"CreateTime": "2023-08-25 09:06:00 ",
"LastUpdate": "2023-08-25 09:06:00 ",
"Status": "",
"InCharge": "tom",
"InChargeId": "123435345",
"StartTime": "2023-08-25 09:09:00 ",
"EndTime": "2023-08-25 09:15:00 ",
"ExecutionStartTime": "2023-08-25 09:09:00 ",
"ExecutionEndTime": "2023-08-25 09:09:00 ",
"CycleType": "D",
"CycleStep": 1,
"CrontabExpression": "0,1 0 0 0 0",
"DelayTime": 1,
"StartupTime": 1,
"RetryWait": 1,
"RetryAble": 1,
"TaskAction": "",
"TryLimit": 1,
"RunPriority": 1,
"TaskType": {
"TypeDesc": "",
"TypeId": 0,
"TypeSort": ""
},
"BrokerIp": null,
"ClusterId": null,
"MinDateTime": null,
"MaxDateTime": null,
"ExecutionTTL": 0,
"SelfDepend": null,
"LeftCoordinate": 0,
"TopCoordinate": 0,
"Notes": null,
"InstanceInitStrategy": null,
"YarnQueue": null,
"LastSchedulerCommitTime": null,
"NormalizedJobStartTime": null,
"SchedulerDesc": null,
"ResourceGroup": null,
"Creator": null,
"DependencyRel": null,
"DependencyWorkflow": null,
"EventListenerConfig": null,
"EventPublisherConfig": null,
"VirtualTaskStatus": null,
"TaskLinkInfo": {
"Id": null,
"LinkKey": null,
"TaskFrom": null,
"TaskTo": null,
"InCharge": null,
"LinkDependencyType": null,
"Offset": null,
"LinkType": null,
"WorkflowId": null
},
"TargetServiceId": null,
"Submit": null,
"SourceServiceId": null,
"TargetServiceType": null,
"TasksStr": null,
"SourceServiceType": null,
"ProductName": null,
"ProjectId": null,
"ProjectIdent": null,
"ProjectName": null,
"OwnId": null,
"UserId": null,
"TenantId": null,
"UpdateUser": null,
"UpdateTime": null,
"UpdateUserId": null,
"TaskTypeId": 0,
"TaskTypeDesc": null,
"ShowWorkflow": true,
"FirstSubmitTime": null,
"FirstRunTime": null,
"ScheduleDesc": null,
"CycleNum": 0,
"Crontab": null,
"StartDate": null,
"EndDate": null,
"CycleUnit": null,
"InitStrategy": null,
"Layer": null
}
],
"Links": [
{
"Id": null,
"LinkKey": null,
"TaskFrom": null,
"TaskTo": null,
"InCharge": null,
"LinkDependencyType": null,
"Offset": null,
"LinkType": null,
"WorkflowId": null
}
],
"UserGroupId": null,
"UserGroupName": null,
"ProjectId": null,
"ProjectIdent": null,
"ProjectName": null,
"Owner": null,
"OwnerId": null
}
],
"TotalFolders": 0,
"FoldersList": null,
"FindType": null
}
]
},
"RequestId": "e125de4f-acc3-22ed-b5fc-123f72e73c62"
}
}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 | 操作失败。 |
