DescribeComfyTasks - 查询Comfy任务列表

更新时间:
复制 MD 格式

查询Comfy任务列表

接口说明

说明

截图查询目前不支持分页,仅支持按迭代方式。使用返回结果里的 extStartTime 参数值,作为新请求的 StartTime 可请求下一页。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vs:DescribeComfyTasks

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TaskId

string

Comfy 工作流 ID,作为过滤条件使用

TaskState

string

任务状态,作为过滤条件使用

QUEUED

WorkflowId

string

Comfy 工作流 ID,作为过滤条件使用

wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f

PageNumber

integer

分页编号

1

PageSize

integer

每页显示的记录数量

20

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

BEA5625F-8FCF-48F4-851B-CA63946DA664

Code

integer

错误码。

0

Message

string

描述信息

success

Tasks

array<object>

任务列表

object

TaskId

string

任务 ID

6c8234f4-d1e1-4cea-b08b-7926fbdea144

WorkflowId

string

任务所使用的 Comfy 工作流 ID

wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f

HiveId

string

任务所使用的资源池 ID

hive-26cd567b35c04a0a90f017388207b2

TaskState

string

任务状态

RUNNING

TaskStateMessage

string

任务状态

TaskErrorMessage

string

任务状态

CreationTime

string

创建时间

1780387493000

UpdatedTime

string

最后修改时间

1780387494000

EndTime

string

任务结束时间

1780387494000

PageNumber

integer

第几页。默认值:1。

1

PageSize

integer

分页大小。

说明

仅限录制查询。

20

Total

integer

任务数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Code": 0,
  "Message": "success",
  "Tasks": [
    {
      "TaskId": "6c8234f4-d1e1-4cea-b08b-7926fbdea144",
      "WorkflowId": "wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f",
      "HiveId": "hive-26cd567b35c04a0a90f017388207b2",
      "TaskState": "RUNNING",
      "TaskStateMessage": "",
      "TaskErrorMessage": "",
      "CreationTime": "1780387493000",
      "UpdatedTime": "1780387494000",
      "EndTime": "1780387494000"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "Total": 1
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情