帮你快速理解、总结文档立即下载

查询工作流列表

最近更新时间:2026-09-11 14:18:55
我的收藏

1. 接口描述

接口请求域名: databuddy.tencentcloudapi.com 。

查询工作流列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListWorkflows。
Version String 公共参数,本接口取值:2026-07-15。
Region String 公共参数,详见产品支持的 地域列表
WorkspaceId String

工作空间ID,可通过 ListWorkspaces 获取。必填


示例值:17697410068842890
PageNumber Integer

分页页码,从 1 开始。非必填,默认 1


示例值:1
PageSize Integer

每页大小。非必填,默认 10,取值范围 [10, 200]


示例值:10
WorkflowNameKeyword String

工作流名称关键字,对 WorkflowName 做模糊匹配。非必填,单值


示例值:demo
WorkflowNames.N Array of String

工作流名称,精确匹配。非必填,多选(多个值之间为 OR 关系)


示例值:["demo"]
WorkflowIds.N Array of String

工作流ID,精确匹配。非必填,多选(多个值之间为 OR 关系)


示例值:["f4ec3e79-7368-44c9-8b04-031fad7f1a76"]
RunUserUins.N Array of String

工作流运行人UIN,精确匹配。非必填,多选(多个值之间为 OR 关系)


示例值:["100044134096"]
LabelKeyIds.N Array of String

标签名称ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)


示例值:["f4ec3e79-7368-44c9-8b04-031fad7f1a76"]
LabelValueIds.N Array of String

标签值ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)


示例值:["f4ec3e79-7368-44c9-8b04-031fad7f1a76"]
QuickSelectionType String

快速筛选类型。非必填,单值

对齐老云 API(wedata/2025-10-10)文档示例值:

  • MY_FAVORITE:我收藏的
  • MY_OWNER:我负责的
  • MY_AUTHORITY:我有权限
  • WorkflowId:支持多个工作流ID筛选

后端实现现状:当前仅 MY_FAVORITE 生效(设置 favoriteUserUin 过滤当前用户收藏),MY_OWNER / MY_AUTHORITY 暂未在 Service 层实现,传入会被忽略(按全量返回)。


示例值:MY_FAVORITE
OrderBys.N Array of OrderBy

排序条件,多个之间按数组顺序表示优先级。非必填。
可排序字段白名单:CreateTime

3. 输出参数

参数名称 类型 描述
Data ListWorkflowsRsp

查询工作流列表响应内容


注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询工作流列表

查询工作流列表

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListWorkflows
<公共请求参数>

{
    "WorkspaceId": "17697410068842890"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "BundleId": "",
                    "BundleInfo": "",
                    "CreateTime": "1785835396477",
                    "CreateUserUin": "*******64618",
                    "Description": "",
                    "GitConfigId": "",
                    "LabelList": [],
                    "OwnerDisplayName": "we*a***************t****",
                    "OwnerUserName": "w***t*****e***encent.com",
                    "OwnerUserUin": "700002164618",
                    "Permission": "MANAGE",
                    "ResourceGroupInfoList": [],
                    "RunUserName": "w***ta30-dev***********m",
                    "RunUserUin": "700002164618",
                    "TaskList": [],
                    "Trigger": [],
                    "UpdateTime": "1785835396477",
                    "WorkflowId": "221dc674-b463-4ea7-a1ed-d76bccf4b5e6",
                    "WorkflowName": "new_workflow_20260804_172315",
                    "WorkflowRunList": []
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1176,
            "TotalPageNumber": 118
        },
        "RequestId": "b0ba39a2-8f9d-439e-8fa7-29a40192d50d"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.WorkflowNoPermission 无操作权限
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ListWorkflowFilterParamError InvalidParameterValue.ListWorkflowFilterParamError
InvalidParameterValue.ParamBlankError 参数 <parameter> 不能为空。
InvalidParameterValue.ParamIllegalError 参数 <parameter> 不符合要求:<message>
MissingParameter 缺少参数错误。