跳转至

DQL 数据异步查询


POST /api/v1/df/asynchronous/query_data

概述

Body 请求参数

参数名 类型 必选 说明
queries array 多命令查询，其内容为 query 对象组成的列表
允许为空: False
fieldTagDescNeeded boolean 是否需要 field 或者 tag 描述信息
允许为空: False

参数补充说明

查询说明

1、 参数说明

参数名 type 必选 说明
queries array Y 多命令查询，其内容为 query 对象组成的列表
fieldTagDescNeeded boolean 是否需要 field 或者 tag 描述信息

2、 queries[*]成员参数结构说明 *** 注意, 在「DQL 数据查询」接口基础上添加了async_id参数 ***

参数名 type 必选 说明
async_id string N 异步查询任务 ID, 该值来自上次 dql 查询结果中的 content.data[*].async_id; 如果上一次查询返回结果中存在该值, 则本次查询需要带上该值
qtype string Y 查询语句的类型
dql: 表示 dql 类型查询语句;
promql: 表示 PromQl 类型查询语句
query json Y 查询结构
query.q string 与 qtype 类型保持一致的 查询语句，例如 dql 或者 promql 查询语句
query.ignore_cache boolean 查询是否禁用缓存, 默认为 fals,表示使用缓存
query.promqlType enum qtype=promql 时生效，promql 的查询类型，可选值 instantQuery 和rangeQuery, 默认值为rangeQuery
query.highlight boolean 是否显示高亮数据
query.timeRange array 时间范围的时间戳列表
query.disableMultipleField bool 是否打开单列模式，默认为 true
query.showLabel bool 是否显示对象的 lables，默认无
query.funcList array 再次聚合修饰 dql 返回值，注意 disableMultipleField=Flse 时, 当前参数无效
query.slimit integer 时间线分组大小，只针对指标查询有效
query.soffset integer 时间线分组偏移量
query.limit integer 分页大小
query.offset integer 分页偏移量
query.orderby array 排序列表，{fieldName:method} , 注意指标集查询的排序只支持 fieldName=time; method in ["desc", "asc"];注意指标集查询的排序只支持 fieldName=time
query.sorderby array 排序列表，sorderby 的 column 是一个表达式，支持所有返回单个值的聚合函数 min max last avg p90 p95 count, {fieldName:method},结构和 orderby 一致
query.order_by array 排序列表，结构为[{"column": "field", "order": "DESC"}], doris 引擎兼容字段
query.sorder_by array 排序列表，结构为[{"column": "field", "order": "DESC"}], doris 引擎兼容字段
query.density string 响应的点密度, 优先级小于 autoDensity 且大于 dql 语句中设置的密度
query.interval integer 单位是秒，时间分片间隔，用于计算响应点数；计算出的点数小于等于 density=high 时的点数，则有效，否则无效
query.search_after array 分页查询标记。相同参数上次请求响应结果中的 search_after 值作为本次请求的参数。
query.maxPointCount integer 最大点数
query.workspaceUUID string 要查询工作空间的 uuid, "*" 表示 查询所有授权的空间 ,可查看空间参考接口 /wksp_share/granted_ws_list
query.workspaceUUIDs array 要查询工作空间的 uuids, 优先级 高于 query.workspaceUUID. ["*"] 表示 查询所有授权的空间,可查看空间参考接口 /wksp_share/granted_ws_list
query.targetRegion string 当指定 查询工作空间为["*"]时, 该字段为必传
query.output_format string lineprotocol: 行协议输出，默认不填的话，默认保持现有输出格式不变
query.cursor_time integer 分段查询阀值: 第一次分段查询时，需要把 cursor_time 设置为 end_time；之后的分段查询，需要把 cursor_time 设置为响应中的 next_cursor_time
query.cursor_token string 分页查询 token(由引擎返回 cursor_token 的值): 分页查询时，需要将上次查询返回的 next_cursor_token 设置为本次查询的 cursor_token；不带 cursor_token 的请求可能会造成翻页时相同时间戳的数据被跳过。
query.disable_sampling bool 采样禁用开关, 默认值为 false

3、 响应点密度density 参数值说明

可选值 说明
lower 较低，60个点
low 低，180个点
medium 中等，360个点
high 低，720个点
  • 注意点密度参数的优先级，最大密度density[high] * maxPointCount > interval > density > dql 语句中的控制参数

4、 常见查询说明

  • 未恢复事件查询 注: openapi 接口进行数据查询时, 默认为 管理员 角色. 需注意可能受到 数据访问规则限制

响应

文档评价

文档内容是否对您有帮助？ ×