1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
根据项目ID获取项目下工作流
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListOpsWorkflows。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目Id 示例值:2763518183736183934 |
PageNumber | 否 | Integer | 分页页码 示例值:1 |
PageSize | 否 | Integer | 分页大小 示例值:10 |
FolderId | 否 | String | 文件Id 示例值:e96fc104-c531-11ef-8c70-043f72d4907c |
Status | 否 | String | 工作流状态筛选 * ALL_RUNNING : 全部调度中 * ALL_FREEZED : 全部已暂停 * ALL_STOPPTED : 全部已下线 * PART_RUNNING : 部分调度中 * ALL_NO_RUNNING : 全部未调度 * ALL_INVALID : 全部已失效 示例值:ALL_RUNNING |
OwnerUin | 否 | String | 负责人Id 示例值:10028596846 |
WorkflowType | 否 | String | 工作流类型筛选, 支持值 Cycle或Manual. 默认只查询 Cycle 示例值:cycle |
KeyWord | 否 | String | 工作流关键词过滤,支持工作流 Id/name 模糊匹配 示例值:da_run_uNO04G |
SortItem | 否 | String | 排序项,可选CreateTime、TaskCount 示例值:TaskCount |
SortType | 否 | String | 排序方式,DESC或ASC, 大写 示例值:desc |
CreateUserUin | 否 | String | 创建人Id 示例值:10028596846 |
ModifyTime | 否 | String | 更新时间,格式yyyy-MM-dd HH:mm:ss 示例值:2025-08-27 23:05:31 |
CreateTime | 否 | String | 创建时间,格式yyyy-MM-dd HH:mm:ss 示例值:2025-08-27 23:05:31 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | OpsWorkflows | 工作流列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取工作流列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListOpsWorkflows
<公共请求参数>
{
"ProjectId": "2428908825624145920"
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "2025-09-01 14:24:26",
"FolderId": "e96fc104-c531-11ef-8c70-043f72d4907c",
"FolderName": "carlshi",
"OwnerUin": ";100028596846;",
"ProjectId": "2428908825624145920",
"ProjectName": "project_wedata_1u62e8u6d4bu4e13u7528",
"Status": "ALL_RUNNING",
"TaskCount": 4,
"UpdateTime": "2025-09-01 14:24:26",
"UpdateUserUin": "100028596846",
"WorkflowDesc": "",
"WorkflowId": "44083d5c-7448-414b-a8c7-0427bd9ee75a",
"WorkflowName": "makeuporder",
"WorkflowType": "cycle"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 540,
"TotalPageNumber": 54
},
"RequestId": "8d95e83b-4fef-454d-a0bf-13b8e2c23177"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter | 参数错误。 |