Domain name for API request: adp.intl.tencentcloudapi.com.
Queries workflow running details.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeWorkflowRun. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| AppId | Yes | String | Application ID. For how to obtain it, see AppId |
| WorkflowRunId | Yes | String | Workflow operation instance ID |
| SubWorkflowNodePath | No | String | The NodePath of the specified sub-Workflow. Format: [<node_id>[<index>].]*<node_id>[<index>] This path is used to locate a specific Workflow instance (Workflow Run), which can be the main Workflow instance or a sub-instance generated by a sub-Workflow node. The path consists of node identifiers separated by dots (.). Each node identifier is in the format of node id[instance index]. node id (node_id): The id of the node to which the sub-Workflow belongs. Instance index (index): The "instance index" is empty for Workflow nodes, and non-empty for loop and batch processing nodes, starting from 1. Example: "" or unset -> Query the main Workflow instance (parent Workflow) "node_id_a" -> Query the sub-Workflow instance corresponding to Workflow node node_id_a in the main Workflow "node_id_a.node_id_b[1]" -> Query the Workflow execution status of the first loop of loop node node_id_b in the sub-Workflow corresponding to Workflow node node_id_a |
| IncludeWorkflowGraph | No | Boolean | Whether to return the process diagram configuration of the workflow |
| Parameter Name | Type | Description |
|---|---|---|
| WorkflowRun | WorkflowRun | Workflow running instance details. |
| NodeRunList | Array of NodeRun | Node list |
| SubWorkflowNodePath | String | NodePath of the sub-workflow |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query workflow running instance details
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkflowRun
<Common request parameters>
{
"AppId": "2075134221221714816",
"WorkflowRunId": "wfr-cd6a2j03k5j4"
}{
"Response": {
"NodeRunList": [
{
"BranchIndexList": [],
"FailCode": "",
"FailMessage": "",
"NodeId": "9e7966a3-43ad-378f-8586-8d5e107a0e2b",
"NodeName": "start",
"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": "Buy a Chery vehicle"
"WorkflowGraph": ""
},
"WorkflowRunOutput": {
"LatestMessage": {
"ContentList": [
{
"FileCollection": null,
"OptionCardList": [],
"Text": "Welcome"
"Type": "text",
"Widget": null
}
]
},
"Output": "None"
},
"WorkflowRunSummary": {
"Domain": 1,
"WorkflowRunProfile": {
"AppId": "2075134221221714816",
"Name": "Buy a vehicle"
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| MissingParameter | Parameters are missing. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan