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

获取节点批次运行详情

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

1. 接口描述

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

DescribeNodeBatchRun

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

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

2. 输入参数

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

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

应用ID


示例值:2046434807234765632
Index 否 Integer

索引号


示例值:3
NodeId 否 String

工作流节点ID


示例值:ed5fc56d-224c-387c-ee3f-427fa60bcb48
SubWorkflowNodePath 否 String

子工作流所属节点

node_id_a.node_id_b[1]


示例值:ed5fc56d-224c-387c-ee3f-427fa60bcb48[1]
WorkflowRunId 否 String

工作流运行ID


示例值:wfr-c928613c-cb3f-4c49-bbc6-83f862067e7f

3. 输出参数

参数名称 类型 描述
FailCode String

错误码


示例值:NodeErr.MQSendMessageFailed
FailMessage String

错误描述


示例值:消息队列生产者发送消息失败: no safe endpoint | 1.检查消息内容的大小是否超过限制。
2.检查消息的序列化格式是否正确。
3.检查 MQ 服务端的日志,看是否有接收错误。
Input String

输入参数


示例值:{"age":3,"name":"hhh"}
InputRef String

输入参数Cos地址


示例值:https://xxxxxxx/xxx/xxx
Output String

输出参数


示例值:{"age":3,"name":"hhh"}
OutputRef String

输出参数Cos地址


示例值:https://xxxxxxx/xxx/xxx
Status Integer
枚举项枚举值描述
NODE_BATCH_RUN_STATUS_UNSPECIFIED0未定义
NODE_BATCH_RUN_STATUS_INIT1初始状态
NODE_BATCH_RUN_STATUS_RUNNING2运行中
NODE_BATCH_RUN_STATUS_SUCCESS3运行成功
NODE_BATCH_RUN_STATUS_FAILED4运行失败
NODE_BATCH_RUN_STATUS_CANCELED5已取消
NODE_BATCH_RUN_STATUS_WAITING_INPUT6待处理

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

4. 示例

示例1 成功示例

输入示例

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

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。