tencent cloud

APIs

DescribeNodeBatchRun

Download
Focus Mode
Font Size
Last updated: 2026-11-04 21:48:17

1. API Description

Domain name for API request: adp.intl.tencentcloudapi.com.

DescribeNodeBatchRun

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeNodeBatchRun.
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 No String

Application ID.

Index No Integer

Index Number

NodeId No String

Workflow Node ID

SubWorkflowNodePath No String

Associated node of the sub-workflow

node_id_a.node_id_b[1]

WorkflowRunId No String

Workflow running ID

3. Output Parameters

Parameter Name Type Description
FailCode String

Error code

FailMessage String

Error description

Input String

Input parameter

InputRef String

Input parameter: Cos address

Output String

Output parameters

OutputRef String

Output parameter: Cos address

Status Integer
Enumeration item Enumeration value Description
NODE_BATCH_RUN_STATUS_UNSPECIFIED 0 undefined
NODE_BATCH_RUN_STATUS_INIT 1 initial status
NODE_BATCH_RUN_STATUS_RUNNING 2 running
NODE_BATCH_RUN_STATUS_SUCCESS 3 run successfully
NODE_BATCH_RUN_STATUS_FAILED 4 execution failed
NODE_BATCH_RUN_STATUS_CANCELED 5 canceled
NODE_BATCH_RUN_STATUS_WAITING_INPUT 6 pending
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.

4. Example

Example1 Successful Example

Input Example

POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNodeBatchRun
<Common request parameters>

{
    "AppId": "2046434807234765632",
    "Index": 3,
    "NodeId": "ed5fc56d-224c-387c-ee3f-427fa60bcb48",
    "WorkflowRunId": "wfr-c928613c-cb3f-4c49-bbc6-83f862067e7f"
}

Output Example

{
    "Response": {
        "FailCode": "",
        "FailMessage": "",
        "Input": "{\"age\":3,\"name\":\"hhh\"}",
        "InputRef": "",
        "Output": "{\"age\":3,\"name\":\"hhh\"}",
        "OutputRef": "",
        "Status": 3,
        "RequestId": "9f9d3dc1-ecb3-41de-8a6a-f9ee011d635b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback