运行查询异步

版本 3.1.23.2

创建异步查询任务

创建查询任务(作业)以异步运行先前创建的查询。返回查询任务 ID。

使用 query_task(query_task_id) 检查查询任务的执行状态。 在查询任务状态达到“完成”后,使用 query_task_results(query_task_id) 提取查询结果。

请求

POST//query_tasks
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
查询参数
展开 CreateQueryTask 定义...
可以
对象
当前用户可以对此对象执行的操作
查询 ID
整数
要运行的查询 ID
result_format
字符串
所需的异步查询结果格式。有效值为“inline_json”“json”“json_detail”“json_fe”“csv”“html”“md”“txt”“xlsx”“gsxml”。
source
字符串
查询任务的来源
deferred
布尔值
创建任务,但推迟执行
Look_id
整数
与查询相关联的样式的 ID。
信息中心 ID
字符串
与查询相关联的信息中心的 ID。
查询
HTTPQuery
展开 HTTPQuery 定义...
限制
整数
行数上限(可能会覆盖已保存查询中的上限)。
apply_formatting
布尔值
为每个模型应用模型指定的格式。
apply_vis
布尔值
将可视化选项应用于结果。
缓存
布尔值
从缓存中获取结果(如果有)。
generate_drill_links
布尔值
生成深入链接(仅适用于“json_detail”格式)。
force_production
布尔值
强制使用生产模型,即使用户处于开发模式。请注意,此标记为 false 并不保证将使用开发模型。
仅缓存
布尔值
从缓存中检索任何结果,即使结果已过期。
路径前缀
字符串
用于细目链接(网址编码)的前缀。
重新构建_pdts
布尔值
重新构建查询中使用的 PDTS。
server_table_calcs
布尔值
对查询结果执行表计算
图片宽度
整数
图片格式的呈现宽度。
图片高度
整数
图片格式的呈现高度。
字段
字符串
请求的字段

响应

200:query_task

数据类型
说明
(对象)
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
查询 ID
整数
查询的 ID
查询
查询
展开查询定义...
可以
对象
当前用户可以对此对象执行的操作
id
整数
唯一 ID
模型
字符串
模型
视图
字符串
探索名称
字段
字符串 []
数据透视
字符串 []
fill_fields
字符串 []
filters
对象
过滤器
过滤条件表达式
字符串
过滤条件表达式
排序
字符串 []
限制
字符串
限制
列限制
字符串
列数上限
总计
布尔值
总计
总行数
字符串
原始总计
小计
字符串 []
vis_config
对象
可视化配置属性。这些属性通常不透明,因所用的可视化类型而异。没有已指定的一组允许的键。这些值可以是 JSON 支持的任何类型。通常具有存在字符串值的“类型”键,供 Looker 用来确定显示哪个可视化图表。可视化图表会忽略未知 vis_config 属性。
过滤条件配置
对象
filter_config 表示给定查询的探索页面上的过滤条件界面的状态。通过 Looker 界面运行查询时,此参数的优先级高于“过滤器”。创建查询或修改现有查询时,应将“filter_config”设置为 null。将其设置为任何其他值都可能会导致意外的过滤行为。该格式应视为不透明。
visible_ui_sections
字符串
可见界面部分
处理后标题
字符串
Slug
动态字段
字符串
动态字段
client_id
字符串
客户端 ID:用于生成缩短的探索网址。如果由客户端设置,则必须是唯一的 22 位字母数字字符串。否则,系统会生成一个。
分享网址
字符串
分享网址
展开网址共享网址
字符串
展开后的共享网址
网址
字符串
展开后的网址
query_timezone
字符串
查询时区
has_table_calculations
布尔值
包含表计算
runtime
数值
(已弃用)运行时(已弃用)
生成链接
布尔值
是否在查询响应中生成链接。
force_production
布尔值
使用生产模型运行查询(即使用户处于开发模式)。
路径前缀
字符串
用于钻研链接的前缀。
缓存
布尔值
是否使用缓存
server_table_calcs
布尔值
是否在服务器上运行表计算
仅缓存
布尔值
从缓存中检索任何结果,即使结果已过期。
cache_key
字符串
用于缓存查询的缓存键。
状态
字符串
查询任务的状态。
source
字符串
查询任务的来源。
runtime
数值
之前查询的运行时。
重新构建_pdts
布尔值
重新构建查询中使用的 PDTS。
result_source
字符串
查询结果的来源。
Look_id
整数
与查询相关联的样式的 ID。
信息中心 ID
字符串
与查询相关联的信息中心的 ID。
result_format
字符串
查询结果的数据格式。

400:错误请求

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

404:未找到

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

409:资源已存在

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

422:验证错误

数据类型
说明
(对象)
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429:请求数过多

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

示例