文档

查询节点进度信息 - comfy_get_progress

更新时间:
一键部署

查询节点进度信息接口说明

接口说明

查询工作流任务执行进度

授权方式

AK/SK,获取方式参考 API授权

请求参数

Body

名称

类型

必填

描述

taskId

string

必填

任务ID,由提交生图任务返回

返回参数

Data

名称

类型

描述

status

string

生图任务状态, 枚举类型:

waiting: 排队中

running: 生图中

failed: 生图失败

successed: 生图成功

progress

double

生图进度,数据范围 0-1

lastQueueRemaining

integer

等待队列长度,当 status = 'waiting' 时,该值有效

etaRelative

double

预期剩余生图执行时间,单位 s

message

string

生图进展简述

state

object

生图详细进度

nodeLabel

string

当前执行节点类型

step

integer

当前节点对应的迭代步数

maxSteps

integer

当前节点最大迭代步数

示例

示范一:排队中

{
    "status": 10,
    "apiInvokeId": "i_66c5ad0babc5ab0023d2e1f6",
    "data": {
        "etaRelative": 0,
        "lastQueueRemaining": 1,
        "progress": 0,
        "taskId": "01j5t2qx82323pswaqykz9eq4",
        "status": "waiting"
    },
    "subErrCode": null,
    "subErrMessage": null,
    "errCode": null,
    "errMessage": null,
    "startTime": null,
    "endTime": null
}

示范二:生图执行中

{
    "status": 10,
    "apiInvokeId": "i_66c5ad1cabc5ab0023d2e1fe",
    "data": {
        "etaRelative": 19.087267,
        "progress": 0.46666667,
        "state": {
            "step": 6,
            "maxSteps": 20,
            "nodeLabel": "IterativeImageUpscale"
        },
        "message": "正在执行节点 图像迭代缩放",
        "taskId": "01j5t2qx82323pswaqykz9eq4",
        "status": "running"
    },
    "subErrCode": null,
    "subErrMessage": null,
    "errCode": null,
    "errMessage": null
}

错误码

(空)