获取渲染任务

版本 4.0.23.6(最新)

获取渲染任务的相关信息。

返回渲染任务对象。如需检查渲染任务的状态,请将 render_task.id 传递给获取渲染任务。 渲染任务完成后,您可以使用获取渲染任务结果下载生成的文档或图片。

请求

获取 /render_tasks/{render_task_id}
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
render_task_id
字符串
渲染任务的 ID
查询
HTTPQuery
展开 HTTPQuery 定义...
字段
字符串
请求的字段。

响应

200:渲染任务

数据类型
说明
(对象)
可以
对象
当前用户可以对此对象执行的操作
创建时间
字符串
创建日期/时间渲染任务
信息中心过滤条件
字符串
过滤应用于信息中心查询的值(采用网址查询格式)
信息中心 ID
字符串
要呈现的信息中心的 ID
信息中心样式
字符串
信息中心布局样式:单列或平铺
最终确定
字符串
完成渲染/渲染任务的日期
高度
整数
输出高度(以像素为单位)。流式布局可能会忽略此值。
id
字符串
此渲染任务的 ID
Look_id
字符串
要呈现的样式的 ID
Lookml_dashboard_id
字符串
要呈现的 Lookml 信息中心的 ID
查询 ID
字符串
要呈现的查询的 ID
信息中心_元素 ID
字符串
要呈现的信息中心元素的 ID:UDD 信息中心元素将为数字,LookML 信息中心元素将为 model_name::dashboard_title::lookml_link_id
query_runtime
数值
运行查询的秒数
render_runtime
数值
呈现数据的秒数
result_format
字符串
输出格式:pdf、png 或 jpg
runtime
数值
渲染任务的总时长(秒)
状态
字符串
渲染任务状态:enqueued_for_query、query、enqueued_for_render、render、success、fail
status_detail [状态详情]
字符串
有关当前状态的更多信息
user_id
字符串
执行渲染任务的用户帐号权限
宽度
整数
输出宽度(以像素为单位)

400:错误请求

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

404:未找到

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

示例