RunningHub AI 应用任务进度显示脚本使用手册

一、工具简介

本脚本是一个用于监控 Runninghub 平台上任务进度的工具。通过脚本，您可以便捷地发起任务、获取任务实时进度（包括总进度、当前执行节点及节点内进度），并在任务完成后获取结果信息。

二、环境准备

1. 运行环境要求

Python 版本：Python 3.6 及以上

依赖库：需要安装以下 Python 库（工具运行依赖）

2. 依赖安装

打开终端（命令提示符 / CMD），执行以下命令安装依赖：

三、配置说明

使用前需先配置工具中的关键参数（位于代码文件头部），这些参数用于与 Runninghub 平台交互，必须正确填写。

1. 核心配置参数

参数名	说明
`API_KEY`	用于身份验证的密钥，Runninghub 平台识别用户身份的凭证
`WORKFLOW_ID`	您要运行的 ComfyUI 工作流 ID，指定需要执行的工作流

API_KEY获取方式：

1.点击API调用栏，到如图界面，点击进入控制台

2.点击复制

WORKFLOW_ID获取方式：（本例子以主页中的工作流为例）

1.点击工作流

2.进入如图界面，上方地址栏中的https://www.runninghub.ai/post/1980214445693689857后面一串数字：1980214445693689857即为WORKFLOW_ID（工作流id）。

2. 配置步骤

用文本编辑器（如 VS Code、记事本等）打开下载好的脚本文件（在文末附有）

找到代码头部的配置区域：

将 API_KEY 和 WORKFLOW_ID 的值替换为您自己的实际信息（删除原示例值，填入您的密钥和工作流 ID）

四、使用步骤

1. 基础使用（默认参数）

如果您不需要自定义任务参数（使用工作流默认配置），直接运行即可：

在最后的完整示例中复制代码，保存到本地命名为xxxx.py（自定义命名即可）

打开终端，进入文件所在目录

执行命令启动工具：

2. 自定义任务参数（可选）

如果需要向工作流传递自定义参数（如输入图片、文本等），需修改 node_info_list 参数：

在代码中找到 main 函数中的 node_info_list 定义：

按照 Runninghub 平台的工作流参数格式，填写自定义参数（需为 JSON 字符串格式）。例如：

（注：具体参数格式需参考您的工作流节点要求，可在 Runninghub 工作流编辑页面查看节点参数说明）

保存文件后，按照「基础使用」步骤运行工具

五、功能说明

工具运行过程中会自动完成以下操作，您可通过终端输出了解实时状态：

1. 任务发起与 WSS 获取

工具首先向 Runninghub 平台发起任务请求，获取 taskId（任务唯一标识）

发起成功后，由于RunningHub平台需要排队，此时工具会轮询平台获取 WSS 链接（用于实时监控进度）：

若任务已快速完成，会直接输出结果（文件类型和 URL）

若任务需要执行一段时间，会获取 WSS 链接并启动进度监控

2. 节点映射获取

工具会自动获取工作流中所有节点的 ID 与名称映射关系，用于在进度中显示节点名称（而非晦涩的 ID），输出类似：

✅ 节点映射获取成功（共7个节点）, 分别是{'3': 'KSampler', '4': 'CheckpointLoaderSimple', '5': 'EmptyLatentImage', '6': 'CLIPTextEncode', '7': 'CLIPTextEncode', '8': 'VAEDecode', '9': 'SaveImage'}

3. 进度监控（核心功能）

通过 WebSocket 实时接收进度信息，终端会动态输出以下内容：

总进度：已完成节点数 / 总节点数的百分比（例如：总进度: 30.0% (3/10)）

当前节点：正在执行的节点名称（例如：当前节点: Upscale）

节点内进度：当前节点的执行进度（例如：(50.0%)，表示该节点已完成一半）

特殊状态提示：

缓存节点完成：📌 节点Resize（缓存完成）（表示该节点使用缓存结果，无需重新执行）

任务完成：🎉 任务完成！（此时会自动关闭监控）

六、输出信息解读

输出示例	含义说明
`✅ 任务发起成功，taskId: 123456`	任务已成功提交到 Runninghub 平台，`taskId` 是该任务的唯一标识
`🔍 第3次轮询...`	正在轮询平台获取 WSS 链接（最多轮询 30 次，每次间隔 5 秒）
`✅ 获取WSS成功：wss://xxx`	已获取到实时监控链接，即将启动进度监控
`📊 进度监控已启动...`	WebSocket 连接已建立，开始接收进度信息
`📈 总进度: 50.0% (5/10) - 当前节点: Upscale (75.0%)`	总进度 50%（10 个节点完成 5 个），当前正在执行「Upscale」节点，该节点已完成 75%
`📌 节点LoadImage（缓存完成）`	「LoadImage」节点使用缓存结果，已标记为完成
`🎉 任务完成！`	所有节点执行完成，任务结束

七、常见问题及解决方法

问题现象	可能原因及解决方法
任务发起异常，提示 “任务发起异常：{...}”	1. `API_KEY` 错误：检查 API 密钥是否正确（注意是否有空格、大小写错误） 2. `WORKFLOW_ID` 错误：确认工作流 ID 是否存在
轮询超时，提示 “❌ 轮询超时，未获取 WSS”	1. 平台处理任务过慢：可尝试重新运行工具 2. 网络问题：检查网络连接是否正常，能否访问 Runninghub 平台 3.排队过久：在Runninghub上发起任务，可能需要一直排队，只有排队成功处于运行状态时才能获取到WebSocket链接。
直接输出任务生成结果，没有任务进度显示	本脚本轮询RunningHub的时间间隔是5s，说明5s内任务从排队到执行完了，所以下一次轮询生成结果直接返回结果。
进度显示节点 ID 而非名称	节点映射获取失败，可忽略（不影响任务执行），或重新运行工具获取映射

八、注意事项

请妥善保管您的 API_KEY，避免泄露给他人（可能导致他人滥用您的平台资源）

若任务长时间无进度更新（超过 10 分钟），可终止工具并重新发起任务

任务完成后，结果文件 URL 会显示在终端中，可直接访问下载（URL 有效期以平台规则为准）

自定义 node_info_list 时，需确保 JSON 格式正确（可使用在线 JSON 校验工具验证）

任务进度显示示例

RunningHub AI 应用任务进度显示脚本使用手册

一、工具简介

二、环境准备

1. 运行环境要求

2. 依赖安装

三、配置说明

1. 核心配置参数

2. 配置步骤

四、使用步骤

1. 基础使用（默认参数）

2. 自定义任务参数（可选）

五、功能说明

1. 任务发起与 WSS 获取

2. 节点映射获取

3. 进度监控（核心功能）

六、输出信息解读

七、常见问题及解决方法

八、注意事项

脚本完整示例

任务进度显示示例

RunningHub AI 应用任务进度显示脚本使用手册#

一、工具简介#

二、环境准备#

1. 运行环境要求#

2. 依赖安装#

三、配置说明#

1. 核心配置参数#

2. 配置步骤#

四、使用步骤#

1. 基础使用（默认参数）#

2. 自定义任务参数（可选）#

五、功能说明#

1. 任务发起与 WSS 获取#

2. 节点映射获取#

3. 进度监控（核心功能）#

六、输出信息解读#

七、常见问题及解决方法#

八、注意事项#

脚本完整示例#

RunningHub AI 应用任务进度显示脚本使用手册

一、工具简介

二、环境准备

1. 运行环境要求

2. 依赖安装

三、配置说明

1. 核心配置参数

2. 配置步骤

四、使用步骤

1. 基础使用（默认参数）

2. 自定义任务参数（可选）

五、功能说明

1. 任务发起与 WSS 获取

2. 节点映射获取

3. 进度监控（核心功能）

六、输出信息解读

七、常见问题及解决方法

八、注意事项

脚本完整示例