查询工作流异步运行实例的详情

最近更新时间:2025-10-15 01:57:17

我的收藏

1. 接口描述

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

创建了工作流的异步运行实例后,通过本接口可以查询整体的运行详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWorkflowRun。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
AppBizId String 应用ID
示例值:1963140753734418240
WorkflowRunId String 工作流运行实例ID
示例值:1dcf5a21-6223-4358-b8a0-b4d6571

3. 输出参数

参数名称 类型 描述
WorkflowRun WorkflowRunDetail 工作流的详情
NodeRuns Array of NodeRunBase 节点列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

查询工作流运行实例详情

输入示例

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

{
    "AppBizId": "1963140753734418240",
    "WorkflowRunId": "wfr-asaodefdu7pc"
}

输出示例

{
    "Response": {
        "NodeRuns": [
            {
                "CostMilliseconds": 0,
                "FailCode": "",
                "FailMessage": "",
                "NodeId": "11a76786-2578-8f2e-ab4e-96fbe393b750",
                "NodeName": "开始",
                "NodeRunId": "nr-e0eecd24-7b19-40c6-b730-77b6f3c0b1c0",
                "NodeType": 1,
                "State": 2,
                "TotalTokens": 0,
                "WorkflowRunId": "wfr-asaodefdu7pc"
            },
            {
                "CostMilliseconds": 105,
                "FailCode": "",
                "FailMessage": "",
                "NodeId": "4bb28c02-c142-4885-958b-e700c88d05e1",
                "NodeName": "代码1",
                "NodeRunId": "nr-d1b55ca0-ca64-46af-8cd7-e59995abd7a4",
                "NodeType": 7,
                "State": 2,
                "TotalTokens": 0,
                "WorkflowRunId": "wfr-asaodefdu7pc"
            },
            {
                "CostMilliseconds": 2971,
                "FailCode": "",
                "FailMessage": "",
                "NodeId": "578d6b2e-d334-1df1-c512-551c358fb790",
                "NodeName": "代码2",
                "NodeRunId": "nr-9fd4a172-eaff-4b97-8479-46a6bc445163",
                "NodeType": 7,
                "State": 2,
                "TotalTokens": 0,
                "WorkflowRunId": "wfr-asaodefdu7pc"
            },
            {
                "CostMilliseconds": 0,
                "FailCode": "",
                "FailMessage": "",
                "NodeId": "88753333-e45b-fdd4-2aa3-7660998fbb91",
                "NodeName": "结束",
                "NodeRunId": "nr-66a33273-e14a-4cc4-b6d2-a76fd3378242",
                "NodeType": 16,
                "State": 2,
                "TotalTokens": 0,
                "WorkflowRunId": "wfr-asaodefdu7pc"
            }
        ],
        "RequestId": "8d785cd9-bf9e-465b-a311-0b765d328b31",
        "WorkflowRun": {
            "AppBizId": "1928404831808934976",
            "CreateTime": "1759142308976",
            "CustomVariables": [
                {
                    "Name": "is_show_tips",
                    "Value": "aaaa"
                }
            ],
            "DialogJson": "{\"ProtoVersion\":\"V2_6\", \"WorkflowID\":\"47d7c1f7-501b-465a-aa6a-73846c92ca44\", \"WorkflowName\":\"代码\", \"WorkflowDesc\":\"代码\", \"Nodes\":[{\"NodeID\":\"11a76786-2578-8f2e-ab4e-96fbe393b750\", \"NodeName\":\"开始\", \"NodeDesc\":\"\", \"NodeType\":\"START\", \"StartNodeData\":{\"WorkflowParams\":[{\"Name\":\"obj\", \"Type\":\"OBJECT\", \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[{\"Name\":\"aaa\", \"Type\":\"STRING\", \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[], \"DefaultValue\":\"\", \"DefaultFileName\":\"\"}, {\"Name\":\"bb\", \"Type\":\"STRING\", \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[], \"DefaultValue\":\"\", \"DefaultFileName\":\"\"}], \"DefaultValue\":\"{\\\"aaa\\\": \\\"AAA\\\", \\\"bb\\\": \\\"BBBB\\\"}\", \"DefaultFileName\":\"\"}, {\"Name\":\"arrarr\", \"Type\":\"ARRAY_ARRAY\", \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[], \"DefaultValue\":\"[[1, 2,3]]\", \"DefaultFileName\":\"\"}]}, \"Inputs\":[], \"Outputs\":[], \"NextNodeIDs\":[\"4bb28c02-c142-4885-958b-e700c88d05e1\", \"578d6b2e-d334-1df1-c512-551c358fb790\"], \"NodeUI\":\"{\\\"data\\\":{\\\"content\\\":{\\\"inputs\\\":[]},\\\"isHovering\\\":false,\\\"isParallel\\\":false,\\\"source\\\":false,\\\"target\\\":true,\\\"debug\\\":null,\\\"error\\\":false,\\\"output\\\":[],\\\"schema\\\":null,\\\"checkDataError\\\":0},\\\"position\\\":{\\\"x\\\":434,\\\"y\\\":482},\\\"targetPosition\\\":\\\"left\\\",\\\"sourcePosition\\\":\\\"right\\\",\\\"selected\\\":false,\\\"measured\\\":{\\\"width\\\":250,\\\"height\\\":84},\\\"dragging\\\":false}\"}, {\"NodeID\":\"88753333-e45b-fdd4-2aa3-7660998fbb91\", \"NodeName\":\"结束\", \"NodeDesc\":\"\", \"NodeType\":\"END\", \"Inputs\":[], \"Outputs\":[{\"Title\":\"Output\", \"Type\":\"OBJECT\", \"Required\":[], \"Properties\":[], \"Desc\":\"输出内容\", \"AnalysisMethod\":\"COVER\"}], \"NextNodeIDs\":[], \"NodeUI\":\"{\\\"data\\\":{\\\"isHovering\\\":false,\\\"isParallel\\\":false,\\\"source\\\":true,\\\"target\\\":false,\\\"debug\\\":null,\\\"error\\\":false,\\\"output\\\":[],\\\"schema\\\":null,\\\"checkDataError\\\":0},\\\"position\\\":{\\\"x\\\":1041,\\\"y\\\":441},\\\"targetPosition\\\":\\\"left\\\",\\\"sourcePosition\\\":\\\"right\\\",\\\"selected\\\":false,\\\"measured\\\":{\\\"width\\\":250,\\\"height\\\":84},\\\"dragging\\\":false}\"}, {\"NodeID\":\"4bb28c02-c142-4885-958b-e700c88d05e1\", \"NodeName\":\"代码1\", \"NodeDesc\":\"\", \"NodeType\":\"CODE_EXECUTOR\", \"CodeExecutorNodeData\":{\"Code\":\"\\nfrom jinja2 import Template\\nimport json\\n\\ndef main(params: dict) -> dict:\\n    input = params.get('input', '{}')  # 获取用户输入的JSON字符串\\n    template = Template(\\\"\\\"\\\"\\n{{ input.name }}\\n{{ input.age }}\\n{{ input.occupation }}\\n    \\\"\\\"\\\")  # 解析JSON字符串,分别输出字段\\n    result = template.render(input=json.loads(input))  # 解析JSON字符串\\n    return {'result': result.splitlines()}  # 返回每个字段为单独的元素\\n\", \"Language\":\"PYTHON3\"}, \"Inputs\":[{\"Name\":\"input\", \"Type\":\"STRING\", \"Input\":{\"InputType\":\"USER_INPUT\", \"UserInputValue\":{\"Values\":[\"{\\\"name\\\": 3, \\\"age\\\": 3, \\\"occupation\\\": 1 }\"]}}, \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[], \"DefaultValue\":\"\", \"DefaultFileName\":\"\"}], \"Outputs\":[{\"Title\":\"Output\", \"Type\":\"OBJECT\", \"Required\":[], \"Properties\":[{\"Title\":\"result\", \"Type\":\"STRING\", \"Required\":[], \"Properties\":[], \"Desc\":\"\", \"AnalysisMethod\":\"COVER\"}], \"Desc\":\"输出内容\", \"AnalysisMethod\":\"COVER\"}], \"NextNodeIDs\":[\"88753333-e45b-fdd4-2aa3-7660998fbb91\"], \"NodeUI\":\"{\\\"data\\\":{\\\"content\\\":{\\\"outputs\\\":[\\\"Output\\\",\\\"Output.result\\\"],\\\"inputs\\\":[\\\"input\\\"]},\\\"isHovering\\\":false,\\\"isParallel\\\":false,\\\"source\\\":true,\\\"target\\\":true,\\\"debug\\\":null,\\\"error\\\":false,\\\"output\\\":[{\\\"id\\\":\\\"21e93433-c30d-1fdc-b470-36275c437521\\\",\\\"value\\\":\\\"Output\\\",\\\"label\\\":\\\"Output\\\",\\\"_uiId\\\":\\\"baedb05d-0daf-9968-5947-e7bb0d878714\\\",\\\"type\\\":\\\"OBJECT\\\",\\\"children\\\":[{\\\"id\\\":\\\"da7598f7-4bea-bb2c-36db-8ea0908099f7\\\",\\\"value\\\":\\\"result\\\",\\\"label\\\":\\\"result\\\",\\\"_uiId\\\":\\\"b3f535b9-f76d-5bd4-849d-94d5b7aa9f20\\\",\\\"type\\\":\\\"STRING\\\",\\\"children\\\":[]}]}],\\\"schema\\\":null,\\\"checkDataError\\\":0},\\\"position\\\":{\\\"x\\\":725,\\\"y\\\":333},\\\"targetPosition\\\":\\\"left\\\",\\\"sourcePosition\\\":\\\"right\\\",\\\"selected\\\":true,\\\"measured\\\":{\\\"width\\\":250,\\\"height\\\":104},\\\"dragging\\\":false}\", \"ExceptionHandling\":{\"Switch\":\"OFF\", \"MaxRetries\":\"3\", \"RetryInterval\":\"1\", \"AbnormalOutputResult\":\"\", \"HandleMethod\":\"EXCEPTION_OUTPUT\", \"NextNodeIDs\":[]}}, {\"NodeID\":\"578d6b2e-d334-1df1-c512-551c358fb790\", \"NodeName\":\"代码2\", \"NodeDesc\":\"\", \"NodeType\":\"CODE_EXECUTOR\", \"CodeExecutorNodeData\":{\"Code\":\"\\n// 请保存函数名为main,输入输出均为object;最终结果会以json字符串方式返回\\nfunction main(params) {\\n    console.log(\\\"XXXXXXXXXXX\\\")\\n    return {\\n        'result': params.input || 0,\\n        'result2': 333,\\n        'arrarr': params.arrarr\\n    };\\n}\\n\", \"Language\":\"JS\"}, \"Inputs\":[{\"Name\":\"input\", \"Type\":\"OBJECT\", \"Input\":{\"InputType\":\"WORKFLOW_VARIABLE\", \"WorkflowParam\":{\"VarBizID\":\"\", \"JsonPath\":\"obj\"}}, \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[], \"DefaultValue\":\"\", \"DefaultFileName\":\"\"}, {\"Name\":\"arrarr\", \"Type\":\"ARRAY_ARRAY\", \"Input\":{\"InputType\":\"WORKFLOW_VARIABLE\", \"WorkflowParam\":{\"VarBizID\":\"\", \"JsonPath\":\"arrarr\"}}, \"Desc\":\"\", \"IsRequired\":false, \"SubInputs\":[], \"DefaultValue\":\"\", \"DefaultFileName\":\"\"}], \"Outputs\":[{\"Title\":\"Output\", \"Type\":\"OBJECT\", \"Required\":[], \"Properties\":[{\"Title\":\"result\", \"Type\":\"OBJECT\", \"Required\":[], \"Properties\":[{\"Title\":\"aaa\", \"Type\":\"STRING\", \"Required\":[], \"Properties\":[], \"Desc\":\"\", \"AnalysisMethod\":\"COVER\"}, {\"Title\":\"bb\", \"Type\":\"STRING\", \"Required\":[], \"Properties\":[], \"Desc\":\"\", \"AnalysisMethod\":\"COVER\"}], \"Desc\":\"\", \"AnalysisMethod\":\"COVER\"}, {\"Title\":\"result2\", \"Type\":\"INT\", \"Required\":[], \"Properties\":[], \"Desc\":\"\", \"AnalysisMethod\":\"COVER\"}], \"Desc\":\"输出内容\", \"AnalysisMethod\":\"COVER\"}], \"NextNodeIDs\":[\"88753333-e45b-fdd4-2aa3-7660998fbb91\"], \"NodeUI\":\"{\\\"data\\\":{\\\"content\\\":{\\\"outputs\\\":[\\\"Output\\\",\\\"Output.result\\\",\\\"Output.result.aaa\\\",\\\"Output.result.bb\\\",\\\"Output.result2\\\"],\\\"inputs\\\":[\\\"input\\\",\\\"arrarr\\\"]},\\\"isHovering\\\":false,\\\"isParallel\\\":false,\\\"source\\\":true,\\\"target\\\":true,\\\"debug\\\":null,\\\"error\\\":false,\\\"output\\\":[{\\\"id\\\":\\\"3e79d81d-78e5-aeb0-5a85-567954684b11\\\",\\\"value\\\":\\\"Output\\\",\\\"label\\\":\\\"Output\\\",\\\"_uiId\\\":\\\"a12efcf2-18fe-98a4-fdd8-063f429de5d3\\\",\\\"type\\\":\\\"OBJECT\\\",\\\"children\\\":[{\\\"id\\\":\\\"c3e020aa-f147-27cc-64b9-ee795c5632fb\\\",\\\"value\\\":\\\"result\\\",\\\"label\\\":\\\"result\\\",\\\"_uiId\\\":\\\"09208fe5-368e-a02d-fd19-db6f6f764fbf\\\",\\\"type\\\":\\\"OBJECT\\\",\\\"children\\\":[{\\\"id\\\":\\\"4cba8343-a4ea-839a-de60-e043920351ec\\\",\\\"value\\\":\\\"aaa\\\",\\\"label\\\":\\\"aaa\\\",\\\"_uiId\\\":\\\"806dd385-0fdb-acbf-3844-f2567d46953d\\\",\\\"type\\\":\\\"STRING\\\",\\\"children\\\":[]},{\\\"id\\\":\\\"38ac6193-6b23-e50a-760e-cf64831c0b67\\\",\\\"value\\\":\\\"bb\\\",\\\"label\\\":\\\"bb\\\",\\\"_uiId\\\":\\\"0a8908cb-f21f-8904-df90-32c7fcd51aff\\\",\\\"type\\\":\\\"STRING\\\",\\\"children\\\":[]}]},{\\\"id\\\":\\\"c00d6733-c70d-5fa6-7121-e77f857256ed\\\",\\\"value\\\":\\\"result2\\\",\\\"label\\\":\\\"result2\\\",\\\"_uiId\\\":\\\"a111c802-bd28-5f6f-cefa-25e2fa198311\\\",\\\"type\\\":\\\"INT\\\",\\\"children\\\":[]}]}],\\\"schema\\\":null,\\\"checkDataError\\\":0},\\\"position\\\":{\\\"x\\\":776,\\\"y\\\":563},\\\"targetPosition\\\":\\\"left\\\",\\\"sourcePosition\\\":\\\"right\\\",\\\"selected\\\":false,\\\"measured\\\":{\\\"width\\\":250,\\\"height\\\":124},\\\"dragging\\\":false}\", \"ExceptionHandling\":{\"Switch\":\"OFF\", \"MaxRetries\":\"3\", \"RetryInterval\":\"1\", \"AbnormalOutputResult\":\"\", \"HandleMethod\":\"EXCEPTION_OUTPUT\", \"NextNodeIDs\":[]}}], \"Edge\":\"[{\\\"source\\\":\\\"11a76786-2578-8f2e-ab4e-96fbe393b750\\\",\\\"target\\\":\\\"4bb28c02-c142-4885-958b-e700c88d05e1\\\",\\\"sourceHandle\\\":\\\"11a76786-2578-8f2e-ab4e-96fbe393b750-source\\\",\\\"type\\\":\\\"custom\\\",\\\"data\\\":{\\\"connectedNodeIsHovering\\\":false,\\\"error\\\":false,\\\"isHovering\\\":false},\\\"id\\\":\\\"xy-edge__11a76786-2578-8f2e-ab4e-96fbe393b75011a76786-2578-8f2e-ab4e-96fbe393b750-source-4bb28c02-c142-4885-958b-e700c88d05e1\\\",\\\"animated\\\":false,\\\"selected\\\":false},{\\\"source\\\":\\\"4bb28c02-c142-4885-958b-e700c88d05e1\\\",\\\"sourceHandle\\\":\\\"4bb28c02-c142-4885-958b-e700c88d05e1-source\\\",\\\"target\\\":\\\"88753333-e45b-fdd4-2aa3-7660998fbb91\\\",\\\"targetHandle\\\":\\\"88753333-e45b-fdd4-2aa3-7660998fbb91-target\\\",\\\"type\\\":\\\"custom\\\",\\\"data\\\":{\\\"connectedNodeIsHovering\\\":false,\\\"error\\\":false,\\\"isHovering\\\":false},\\\"id\\\":\\\"xy-edge__4bb28c02-c142-4885-958b-e700c88d05e14bb28c02-c142-4885-958b-e700c88d05e1-source-88753333-e45b-fdd4-2aa3-7660998fbb9188753333-e45b-fdd4-2aa3-7660998fbb91-target\\\",\\\"animated\\\":false,\\\"selected\\\":false},{\\\"source\\\":\\\"11a76786-2578-8f2e-ab4e-96fbe393b750\\\",\\\"sourceHandle\\\":\\\"11a76786-2578-8f2e-ab4e-96fbe393b750-source\\\",\\\"target\\\":\\\"578d6b2e-d334-1df1-c512-551c358fb790\\\",\\\"targetHandle\\\":\\\"578d6b2e-d334-1df1-c512-551c358fb790-target\\\",\\\"type\\\":\\\"custom\\\",\\\"data\\\":{\\\"connectedNodeIsHovering\\\":false,\\\"error\\\":false,\\\"isHovering\\\":false},\\\"id\\\":\\\"xy-edge__11a76786-2578-8f2e-ab4e-96fbe393b75011a76786-2578-8f2e-ab4e-96fbe393b750-source-578d6b2e-d334-1df1-c512-551c358fb790578d6b2e-d334-1df1-c512-551c358fb790-target\\\",\\\"animated\\\":false,\\\"selected\\\":false},{\\\"source\\\":\\\"578d6b2e-d334-1df1-c512-551c358fb790\\\",\\\"sourceHandle\\\":\\\"578d6b2e-d334-1df1-c512-551c358fb790-source\\\",\\\"target\\\":\\\"88753333-e45b-fdd4-2aa3-7660998fbb91\\\",\\\"targetHandle\\\":\\\"88753333-e45b-fdd4-2aa3-7660998fbb91-target\\\",\\\"type\\\":\\\"custom\\\",\\\"data\\\":{\\\"connectedNodeIsHovering\\\":false,\\\"error\\\":false,\\\"isHovering\\\":false},\\\"id\\\":\\\"xy-edge__578d6b2e-d334-1df1-c512-551c358fb790578d6b2e-d334-1df1-c512-551c358fb790-source-88753333-e45b-fdd4-2aa3-7660998fbb9188753333-e45b-fdd4-2aa3-7660998fbb91-target\\\",\\\"animated\\\":false,\\\"selected\\\":false}]\", \"Mode\":\"NORMAL\", \"ReleaseTime\":\"\"}",
            "EndTime": "1759142312152",
            "FailMessage": "",
            "MainModelName": "cs-normal-70b",
            "Name": "代码",
            "Output": "{\"output\": 22}",
            "Query": "22",
            "RunEnv": 0,
            "StartTime": "1759142309058",
            "State": 2,
            "TotalTokens": 0,
            "WorkflowId": "47d7c1f7-501b-465a-aa6a-73846c92ca44",
            "WorkflowRunId": "wfr-asaodefdu7pc"
        }
    }
}

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