帮你快速理解、总结文档立即下载
文档中心>腾讯云智能体开发平台>API 文档>工作流相关接口>查询工作流运行实例详情

查询工作流运行实例详情

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

本页目录：

1. 接口描述

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

查询工作流运行详情

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

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

2. 输入参数

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

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

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


示例值：1963140753734418240
WorkflowRunId 是 String

工作流运行实例ID


示例值：1dcf5a21-6223-4358-b8a0
SubWorkflowNodePath 否 String

指定的子工作流对应的NodePath。 格式：[<node_id>[<index>].]*<node_id>[<index>] 此路径用于定位一个具体的工作流实例（Workflow Run），可以是主工作流实例或某个子工作流节点产生的子实例。 路径由点号（.）分隔的节点标识符组成，每个节点标识符格式为 节点ID[实例索引]。 节点ID (node_id)：子工作流所属的节点的ID。 实例索引 (index)：“实例索引” 在工作流节点的时候为空，循环、批处理节点非空，从1开始。 示例： "" 或 不设置 -> 查询主工作流实例 (父工作流) "node_id_a" -> 查询由主工作流中工作流节点node_id_a对应的子工作流实例 "node_id_a.node_id_b[1]" -> 查询工作流节点node_id_a对应的子工作流的循环节点node_id_b的第1轮循环的子工作流运行状态


示例值：8ad82e0553507b4c1ba771fb53029492
IncludeWorkflowGraph 否 Boolean

是否需要返回工作流的流程图配置


示例值：false

3. 输出参数

参数名称 类型 描述
WorkflowRun WorkflowRun

工作流运行实例详情
NodeRunList Array of NodeRun

节点列表
SubWorkflowNodePath String

子工作流对应的NodePath


示例值：8ad82e0553507b4c1ba771fb53029492
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询工作流运行实例详情

查询工作流运行实例详情

输入示例

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

{
    "AppId": "2075134221221714816",
    "WorkflowRunId": "wfr-cd6a2j03k5j4"
}

输出示例

{
    "Response": {
        "NodeRunList": [
            {
                "BranchIndexList": [],
                "FailCode": "",
                "FailMessage": "",
                "NodeId": "9e7966a3-43ad-378f-8586-8d5e107a0e2b",
                "NodeName": "开始",
                "NodeRunId": "nr-6f7aa512-f336-4ee1-b78e-a987f61ffd07",
                "NodeType": 1,
                "Status": 3,
                "TotalCostMs": 0,
                "TotalTokens": 0,
                "WorkflowRunId": "wfr-cd6a2j03k5j4"
            }
        ],
        "SubWorkflowNodePath": "",
        "WorkflowRun": {
            "WorkflowRunMetadata": {
                "CustomVariableList": [],
                "MainModelName": "Youtu/youtu-mrc-pro",
                "Query": "买奇瑞汽车",
                "WorkflowGraph": ""
            },
            "WorkflowRunOutput": {
                "LatestMessage": {
                    "ContentList": [
                        {
                            "FileCollection": null,
                            "OptionCardList": [],
                            "Text": "欢迎光临",
                            "Type": "text",
                            "Widget": null
                        }
                    ]
                },
                "Output": "{无}"
            },
            "WorkflowRunSummary": {
                "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": "461b7bb7-ded9-4f02-814e-afb07ee4ffb7"
    }
}

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 缺少参数错误。
中国站