You need to enable JavaScript to run this app.
导航

获取渲染任务列表

最近更新时间2023.09.18 20:30:23

首次发布时间2023.09.18 20:30:23

本接口名称为list_render_job

请求参数

名称

类型

是否必选

默认值

描述

params

dict

参数解释参见params

params

名称

类型

是否必选

描述

WorkspaceId

int

工作区 ID。

PageNum

int

分页页码。从 1 开始,默认为 1。

PageSize

int

单页展示的渲染任务数量,最小值为 1,默认值为 10 。

OrderBy

int

排序方式,取值范围如下:

  • asc(默认值):升序
  • desc:降序

OrderField

string

排序所依据的字段,取值范围如下:

  • created_at:渲染任务创建时间
  • priority:渲染任务优先级
  • title:渲染任务名称

Keyword

string

根据关键字搜索

Status

string

根据状态过滤,多个状态使用逗号分隔,状态的取值范围如下:

  • Empty
  • Starting
  • Queueing
  • Analyzing
  • Processing
  • Rendered
  • Cleanup
  • Finished
  • Paused
  • Error
  • Deleted
  • Stopped
  • TryoutFinished
  • TryoutError

RenderSetting

string

根据渲染配置 ID 过滤,多个渲染配置之间使用逗号分隔

DeviceName

string

根据客户端所在的设备名称过滤,DeviceName参见创建渲染任务的DeviceName参数。非特殊需要此参数填空字符串即可。

UserId

int64

根据子账号 ID 过滤,多个子账号之间使用逗号分隔。非特殊需要,此参数填 0 即可。

返回参数

名称

类型

描述

render_jobs

dict

{
"Jobs": [ {

}

]
}

Jobs 的参数解释参见创建渲染任务的返回参数。

调用示例

请参见 list_render_job_demo.py