1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询用户生产工作流列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOpsWorkflows。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目id |
| ProductNameList | 否 | String | 任务产品类型名称列表，以 ',' 号分割 示例值：TEST |
| FolderIdList | 否 | String | 文件id列表，以 ',' 号分割 示例值：e1c0831c-e1a3-11ee-8ec8-b8599f277de5 |
| WorkFlowIdList | 否 | String | 工作流id，以 ',' 号分割 示例值：默认文件夹 |
| WorkFlowNameList | 否 | String | 工作流名称列表，以 ',' 号分割 示例值：testworkflow1 |
| TaskNameList | 否 | String | 任务名称列表，以 ',' 号分割 示例值：taskname1 |
| TaskIdList | 否 | String | 任务id列表，以 ',' 号分割 示例值：taskId1 |
| StatusList | 否 | String | 状态列表，以 ',' 号分割 示例值：ALL_STOPPTED |
| InChargeList | 否 | String | 负责人列表，以 ',' 号分割 示例值：jack |
| PageNumber | 否 | Integer | 分页页码 示例值：1 |
| PageSize | 否 | Integer | 分页大小 示例值：10 |
| SortItem | 否 | String | 排序项 示例值：FirstSubmitTime |
| SortType | 否 | String | 排序方式，DESC或ASC 示例值：DESC |
| ProjectIds.N | 否 | Array of String | 项目ID列表，用于多项目工作流筛选 |
| WorkflowTypeList.N | 否 | Array of String | 工作流类型列表 多个用英文逗号连接 cycle,manual. 默认只查询 cycle 示例值：cycle |
| KeyWord | 否 | String | 工作流过滤keyword，支持工作流 id/name 模糊匹配， 多个用|分割 示例值：test_wf |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | WorkflowExtOpsDtoPage | 工作流列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户生产工作流列表
查询用户生产工作流列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOpsWorkflows
<公共请求参数>
{
"ProjectId": "1531609696090365852",
"PageNumber": 1,
"PageSize": 10
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "2024-03-13 20:07:03",
"FolderId": "14ac5d0f-e132-11ee-8d13-a4ae120f8272",
"FolderName": "0sasha",
"ModifyTime": "2024-03-13 20:07:03",
"Owner": ";AUTO_TEST;",
"OwnerId": ";100029411056;",
"ProjectId": "1531609696090365952",
"ProjectIdent": null,
"ProjectName": "project_wedata",
"Status": "ALL_RUNNING",
"TaskCount": 3,
"WorkFlowDesc": "",
"WorkFlowId": "1a791878-e132-11ee-8d13-a4ae120f8272",
"WorkFlowName": "saflow"
}
],
"TotalCount": 1
},
"RequestId": "80f565cd-e63a-427a-98e5-c729d7e0e3f2"
}
}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 | 操作失败。 |
