文档中心

创建渲染任务

最近更新时间：2023.09.18 20:45:29

首次发布时间：2023.09.18 20:30:24

本接口名称为create_render_job。

说明

创建渲染任务前，需确保渲染所需的资产文件都已上传成功、渲染配置已创建。

请求参数

名称	类型	是否必填	默认值	描述
params	dict	是	无	{ "WorkspaceId": 1993 } 参数解释如下： WorkspaceId：工作区 ID。
body	dict	是	无	具体参数解释见body。有关创建渲染任务中各个配置项的详细解释，请参见提交渲染任务。

名称

类型

是否必填

默认值

描述

params

dict

是

无

{
"WorkspaceId": 1993
}

参数解释如下：
WorkspaceId：工作区 ID。

body

dict

是

无

具体参数解释见body。有关创建渲染任务中各个配置项的详细解释，请参见提交渲染任务。

body

名称	类型	是否必选	默认值	说明
Title	String	是	无	渲染任务名称。
Description	String	否	无	渲染任务描述。
Renderer	String	是	无	渲染器名称，建议从渲染配置里获取，如 MtoA。
Tryout	Bool	否	无	是否开启试渲染。默认为不开启。
TryoutFrameNumbers	[]String	否	无	开启试渲染后此参数才有意义，需指定要试渲染的帧列表。
MayaProjectPath	String	否	无	Maya 文件工程路径。
SceneFile	String	是	无	场景文件路径，上传文件后返回的服务端路径，如 D/test.ma
PathMapping	dict	否	无	路径映射。
TimeoutReminderEachFrame	Int	否	无	单帧超时提醒时间，单位为秒。
TimeoutStopperEachFrame	Int	否	无	单帧超时停止时间，单位为秒。
UseLegacyRenderLayers	Bool	否	无	是否使用 Legacy 渲染层模式。
LayerConfig	[]layer	是	无	渲染层设置。具体参数解释见layer。
FrameCountEachCell	Int	否	无	一机多帧设置。
DeviceName	String	否	无	设备名称。
AutoRetryNumber	Int	否	无	自动重渲染次数，默认为 1。
RenderSetting	dict	是	无	渲染配置详情。可从获取渲染配置详情的返回值中获取。

layer

名称	类型	是否必选	默认值	说明
LayerIndex	Int64	是	无	渲染层序号。
LayerName	String	是	无	渲染层名称。
Frame	dict	是	无	渲染帧。具体参数解释见Frame。
Resolutions	dict	是	无	分辨率。具体参数解释见Resolutions。
Cameras	String	是	“文件内设置”	相机设置。

Frame

名称	类型	是否必选	默认值	描述
Start	Int64	是	无	起始帧。
End	Int64	是	无	结束帧。
Step	Int64	是	1	帧间隔。

Resolutions

名称	类型	是否必选	默认值	描述
Width	Int64	是	无	宽度。
Height	Int64	是	无	高度。

返回参数

名称	类型	描述
render_job	dict	具体参数描述见render_job。

render_job

名称	类型	描述
UserId	Int64	子账号 ID。
AccountId	Int64	主账号 ID。
UserName	String	子账号用户名。
WorkspaceId	Int64	工作区 ID。
Title	String	渲染任务名称。
Description	String	渲染任务描述。
DccTool	String	DCC 软件名称。支持的软件请参见支持的软件和插件版本。
DccToolVersion	String	DCC 软件版本。
Renderer	String	渲染器名称。
RendererVersion	String	渲染器版本。
Tryout	Bool	是否开启试渲染。默认为不开启。
SceneFile	String	场景文件路径，上传文件后返回的服务端路径，如 D/test.ma
OutputFormat	String	渲染结果文件输出格式。
FrameSettings	String	渲染帧设置。
Cameras	String	相机设置。
Layers	String	渲染层。
TimeoutReminderEachFrame	Int64	渲染超时提醒设置，单位为秒。
TimeoutStopperEachFrame	Int64	渲染超时停止设置，单位为秒。
LayerInformationList	[]String	渲染层信息列表。
FrameProcess	String	渲染帧进度。
OutputImageTemple	String	渲染输出结果图片。
WantedCellSpecs	dict	目标规格。具体参数解释见WantedCellSpecs。
UseLegacyRenderLayers	Bool	是否为 LegacyRenderLayer 模式。
UserData	String	用户数据。
LayerConfig	dict	渲染层设置。具体参数解释见layer。
FrameCountEachPod	Int64	一机多帧设置。
RenderSettingId	Int64	渲染配置 ID。
RenderSettingName	String	渲染配置名称。
AutoRetryNumber	Int	自动重渲染次数，默认为 1。
JobId	String	渲染任务 ID。
Priority	Int64	渲染任务优先级。
CreatedAt	String	渲染任务创建时间。
Stage	String	渲染任务状态。
Statistics	dict	渲染任务统计数据。具体参数解释见statistics。
ResultBucket	String	结果统计数据。
ResultDirectoryPath	String	渲染结果文件路径。
OutputBytes	Int64	渲染结果文件大小。
RenderSetting	dict	`{ 'Id': 360 },` ld：渲染配置 ID。
Plugins	[]DccPlugin	渲染插件。

WantedCellSpecs

名称	类型	描述
ComputerResourceType	String	计算资源类型。
ComputerResourceCount	Int64	计算资源数量。
Id	Int64	计算规格 ID。

statistics

名称	类型	描述
CpuTime	Int64	核时。
GpuTime	Int64	卡时。
Cost	Int64	渲染费用。
RenderTime	Int64	渲染时长。

异常列表

异常返回结果	说明
ErrInvalidJobRequest	请求参数错误，例如：渲染配置错误。
NullFrame	未配置渲染层或未配置渲染层中的帧。
InvalidTaskCount	一机多帧配置错误。
ErrDccPluginInvalid	DCC 软件或渲染插件不存在。

调用示例

请参见 create_render_job_demo.py。

请求参数

body

layer

返回参数

render_job

WantedCellSpecs

statistics

异常列表

调用示例

边缘渲染

创建渲染任务

请求参数

body

layer

Frame

Resolutions

返回参数

render_job

WantedCellSpecs

statistics

异常列表

调用示例