1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
根据文件夹查询工作流
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWorkflowByFordIds。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目Id 示例值：1464962169590902784 |
| FolderIdList.N | 是 | Array of String | 文件夹Id 示例值：["0b3ceaca-d0b1-11ee-8ec8-b8599f277de5"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of WorkflowDsDTO | 工作流详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkflowByFordIds
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"FolderIdList": [
"3a80fd12-4b82-11f0-8ec8-b8599f277de5"
]
}输出示例
{
"Response": {
"Data": [
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "c3c6520d-673f-4822-960e-51dd2459815b",
"WorkflowName": "t1",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "be82f3b2-0a4d-489b-8264-ad6d1737096d",
"WorkflowName": "t2",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "5e0c3a6f-fe6a-43b9-b53a-790123aacd94",
"WorkflowName": "test_wf66",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "5af11d35-95c9-4fb3-a732-721ba23bd9bb",
"WorkflowName": "test_wf_2",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "69b2a0a4-b7c6-4d84-ac42-524bfc2e3ae2",
"WorkflowName": "test_wf_b",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "35b9a5b9-aa69-43b7-9895-4e1c4e2f33b6",
"WorkflowName": "test_wf_c",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": null,
"UpdateUserId": null,
"WorkflowDesc": "",
"WorkflowId": "9374cd08-cd0e-4d92-9ba6-0815e258d7c5",
"WorkflowName": "test_wf_x",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "0b3cd7ab-1da0-4605-bbc9-aa97c2cda1aa",
"WorkflowName": "test_wf_y",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "ecf1bb87-4912-4039-89ab-380e3ae87cd6",
"WorkflowName": "test_wf_z",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": null,
"UpdateUserId": null,
"WorkflowDesc": "",
"WorkflowId": "177dea6e-bc8e-4c41-8892-d0c043a6e8b7",
"WorkflowName": "test_workflow1",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "4e08ea77-7839-4c31-a66f-0666ccaa24a4",
"WorkflowName": "wf12",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": null,
"UpdateUserId": null,
"WorkflowDesc": "",
"WorkflowId": "a6557acf-1dc4-4251-84c2-c1210d5a6390",
"WorkflowName": "wf2",
"WorkflowType": "cycle"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "f13295ee-eac1-406a-ad8f-f4652e1386ef",
"WorkflowName": "wf3",
"WorkflowType": "manual"
},
{
"FolderId": "3a80fd12-4b82-11f0-8ec8-b8599f277de5",
"Links": null,
"Owner": ";jasonzcwang;",
"OwnerId": ";100042680225;",
"Params": null,
"ProjectId": "1470547050521227264",
"ProjectIdent": "wedata_dev_new",
"ProjectName": "wedata数据开发_新",
"SparkParams": null,
"Tasks": null,
"UpdateUser": "jasonzcwang",
"UpdateUserId": "100042680225",
"WorkflowDesc": "",
"WorkflowId": "b98dafac-be81-428c-bdad-5fc9ade5f4b6",
"WorkflowName": "wf6",
"WorkflowType": "cycle"
}
],
"RequestId": "d669abaf-2c17-4607-ada6-a47ec0b47d98"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
