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

查询工作流运行实例列表

最近更新时间:2026-10-12 10:41:13
我的收藏

1. 接口描述

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

查询工作流运行实例列表

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

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

2. 输入参数

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

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

应用ID, 获取方法参看如何获取 AppId


示例值:1854548189164339200
PageSize 是 Integer

每页数量(取值范围1-200)


示例值:20
PageNumber 是 Integer

页码(必须大于0)


示例值:1
Domain 是 Integer

运行环境。1:开发域,2:生产域 -


示例值:1
FilterList.N 否 Array of Filter

参数过滤

3. 输出参数

参数名称 类型 描述
TotalCount Integer

总数


示例值:100
WorkflowRunSummaryList Array of WorkflowRunSummary

工作流运行实例列表

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询工作流运行实例列表

查询工作流运行实例列表

输入示例

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

{
    "AppId": "2075134221221714816",
    "PageSize": 15,
    "PageNumber": 1,
    "Domain": 1,
    "FilterList": [
        {
            "Name": "WorkflowRunId",
            "ValueList": [
                "wfr-cd6a2j03k5j4"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "WorkflowRunSummaryList": [
            {
                "Domain": 1,
                "WorkflowRunProfile": {
                    "AppId": "2075134221221714816",
                    "Name": "买汽车",
                    "WorkflowId": "f5d9e1eb-d6c3-4529-93b1-f041ea3347cc",
                    "WorkflowRunId": "wfr-cd6a2j03k5j4"
                },
                "WorkflowRunResult": {
                    "FailMessage": "",
                    "Status": 3,
                    "TotalTokens": 1647
                },
                "WorkflowRunTime": {
                    "CreateTime": "1783932410370",
                    "EndTime": "1783932471294",
                    "StartTime": "1783932410478"
                }
            }
        ],
        "RequestId": "30fcc9bd-5239-47ce-847a-5cdedf7b50ab"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
MissingParameter 缺少参数错误。