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

工作流运行列表

最近更新时间:2026-09-14 01:46:30
我的收藏

1. 接口描述

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

工作流运行列表

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

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

2. 输入参数

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

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

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


示例值:17622177773248536
PageNumber Integer

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


示例值:1
PageSize Integer

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


示例值:10
WorkflowId String

工作流ID,精确匹配。非必填,单值


示例值:f4ec3e79-7368-44c9-8b04-031fad7f1a76
WorkflowNameKeyword String

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


示例值:demo
CreateStartTime String

运行创建时间下界,范围匹配(CreateTime >= 本值),单位:毫秒时间戳。
非必填,单值,对应出参 WorkflowRun.CreateTime


示例值:1773244800000
CreateEndTime String

运行创建时间上界,范围匹配(CreateTime <= 本值),单位:毫秒时间戳。
非必填,单值,对应出参 WorkflowRun.CreateTime


示例值:1773244800000
RunStates.N Array of String

运行状态,精确匹配。非必填,多选(多个值之间为 OR 关系)。

可填 SUCCESS / FAILED 等,具体参考本接口出参 WorkflowRun.RunState 字段返回值。


示例值:["ACTIVE"]
ErrorCodeStrings.N Array of String

错误码,精确匹配。非必填,多选(多个值之间为 OR 关系)


示例值:["demo"]
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"]
OrderBys.N Array of OrderBy

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

3. 输出参数

参数名称 类型 描述
Data ListWorkflowRunsRsp

工作流运行列表响应内容


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

4. 示例

示例1 工作流运行列表

输入示例

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

{
    "WorkspaceId": "17622177773248536",
    "PageNumber": 1,
    "PageSize": 10,
    "WorkflowId": "f4ec3e79-7368-44c9-8b04-031fad7f1a76",
    "WorkflowNameKeyword": "demo",
    "CreateStartTime": "1773244800000",
    "CreateEndTime": "1773244800000",
    "RunStates": [
        "ACTIVE"
    ],
    "ErrorCodeStrings": [
        "demo"
    ],
    "RunUserUins": [
        "100044134096"
    ],
    "LabelKeyIds": [
        "f4ec3e79-7368-44c9-8b04-031fad7f1a76"
    ],
    "LabelValueIds": [
        "f4ec3e79-7368-44c9-8b04-031fad7f1a76"
    ],
    "OrderBys": []
}

输出示例

{
    "Response": {
        "Data": {
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1,
            "TotalPageNumber": 1,
            "Items": [],
            "BizStateEnumInfos": [],
            "BizErrorCodeEnumInfos": []
        },
        "RequestId": "43144820-519a-4b91-b2b3-4835ed5b35f5"
    }
}

示例2 按默认分页查询工作空间下工作流运行列表

按默认分页查询工作空间下工作流运行列表

输入示例

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

{
    "WorkspaceId": "17697410068842890"
}

输出示例

{
    "Response": {
        "Data": {
            "BizErrorCodeEnumInfos": [
                {
                    "Count": 12576,
                    "LabelKey": "",
                    "LabelValue": ""
                }
            ],
            "BizStateEnumInfos": [
                {
                    "Count": 12091,
                    "LabelKey": "SUCCESS",
                    "LabelValue": "成功"
                }
            ],
            "Items": [
                {
                    "AdvancedParameters": [],
                    "AppId": "251436191",
                    "CreateTime": "1786115878109",
                    "EndTime": "0",
                    "ErrorCodeString": "",
                    "LabelList": [],
                    "ParentWorkflowRunId": "",
                    "ParentWorkflowTaskRunId": "",
                    "ParentWorkflowTaskRunName": "",
                    "PendingCostTime": "37",
                    "PendingStartTime": "0",
                    "Permission": "MANAGE",
                    "QueueCostTime": "0",
                    "QueueStartTime": "0",
                    "RerunTimes": 0,
                    "ResourceGroupIds": [],
                    "ResourceGroupInfoList": [],
                    "RunCostTime": "0",
                    "RunEndTime": "0",
                    "RunStartTime": "0",
                    "RunState": "QUEUED",
                    "RunUserName": "",
                    "RunUserUin": "700002164618",
                    "SelectedTaskIds": [
                        "40d34e5c-12d9-4ac3-88ed-2f879713d4e4"
                    ],
                    "SupportRerun": false,
                    "TriggerType": "",
                    "WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
                    "WorkflowName": "new_workflow_20260807_190451",
                    "WorkflowParams": "{\"pppp1\":\"vvvv1\"}",
                    "WorkflowRunId": "8e0e3485-2736-4530-92ed-932e019898f1_1786115878097",
                    "WorkflowVersionId": "bcac4a2c-a47a-453b-8e31-34282e556db2",
                    "WorkspaceId": "17697410068842890"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 106670,
            "TotalPageNumber": 10667
        },
        "RequestId": "5f543f6f-7fae-47e9-8add-eb9d045d1bea"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.ExistWorkflowExecutions 存在活跃的工作流运行,无法操作
FailedOperation.WorkflowNoPermission 无操作权限
InternalError 内部错误。
InternalError.UnknownError InternalError.UnknownError
InvalidParameterValue.InvalidParameter 参数错误
InvalidParameterValue.ParamBlankError 参数 <parameter> 不能为空。
InvalidParameterValue.ParamIllegalError 参数 <parameter> 不符合要求:<message>
InvalidParameterValue.ParamNullError 参数 <parameter> 不能为 null。
InvalidParameterValue.WorkflowEndTimeLessStartTime 结束时间不能早于开始时间
InvalidParameterValue.WorkflowQueryEndTimeAndStartTimeExceed 查询时间范围超过60天限制
MissingParameter.MissingParameter 缺少必填参数
ResourceNotFound.WorkflowNotExist ResourceNotFound.WorkflowNotExist