跳转至

DQL数据查询


POST /api/v1/df/{workspace_uuid}/query_data

概述

路由参数

参数名 类型 必选 说明
workspace_uuid string Y 签名请求访问的基准工作空间 UUID；默认查询该工作空间，跨空间目标放在 queries[*].query 中

Body 请求参数

参数名 类型 必选 说明
sceneUUID string 场景UUID
允许为空: False
dashboardUUID string 视图UUID
允许为空: False
testTimeout float 制造 ban 操作的超时时间（debug模式下有效）
允许为空: False
queries array 多命令查询，其内容为 query 对象组成的列表
允许为空: False
fieldTagDescNeeded boolean 是否需要field 或者tag描述信息
允许为空: False
expensiveQueryCheck boolean 是否需要检查wildcard左*的情况
允许为空: False
dataQueryPreview json 数据访问的预览功能
允许为空: False
dataQueryPreview.maskFields string 脱敏字段, 多个字段用,号分隔
例子: message,host
允许为空: False
允许空字符串: True
dataQueryPreview.reExprs array 正则表达式
例子: [{'name': 'jjj', 'reExpr': 'ss', 'enable': 0}, {'name': 'lll', 'reExpr': 'ss', 'enable': 1}]
允许为空: False

参数补充说明

查询说明

本接口为同步查询入口，路径参数 workspace_uuid 是签名请求所访问的基准工作空间。 请求体不支持 async_id；async_id 只属于 OpenAPI 的 /api/v1/df/asynchronous/query_data 异步任务生命周期，不能在本接口中复用。

本接口底层与 OpenAPI query_data 共享 DQL 查询参数。跨工作空间查询时， 非空 query.workspaceUUIDs 优先于 query.workspaceUUID；当它为空数组或 null 时会回退使用 query.workspaceUUID，建议不要同时传两个字段。一个请求中的所有 queries[*] 只能指向同一个 query.targetRegion。需要查询多个站点时，应按站点 拆分请求并在客户端合并结果。目标工作空间与站点编码的选择参考： OpenAPI 跨站点数据查询。

1、 queries 数组元素字段说明

参数名 type 必选 说明
sceneUUID string N 可选场景 UUID
dashboardUUID string N 可选视图 UUID；特殊内置视图可能影响查询上下文
queries array N query 对象列表；业务查询应至少传入一项，省略或传空列表时返回空数据

2、 DQL JSON结构参数说明(queries[*]元素)

  • 基础字段 *
参数名 type 必选 说明
qtype string Y 查询语句的类型
dql: DQL 查询语句；
promql: PromQL 查询语句
query json Y 查询结构
query.q string 与 qtype 类型保持一致的 查询语句，例如 dql 或者 promql 查询语句
query.ignore_cache boolean 是否禁用缓存，默认 false，表示使用缓存
query.promqlType enum qtype=promql 时生效，可选值 instantQuery、rangeQuery，默认 rangeQuery
query.highlight boolean 是否显示高亮数据
query.timeRange array 时间范围的时间戳列表；DQL / PromQL 的起止时间须使用相同单位（秒、毫秒、微秒或纳秒），混用时返回 HTTP 400 ft.TimeRangeUnitMismatch；分页游标保持独立
query.disableMultipleField bool 是否打开单列模式，默认为 true
query.showLabel bool 是否显示对象的 labels，默认 false
query.funcList array 再次聚合修饰 DQL 返回值；disableMultipleField=false 时当前参数无效
query.slimit integer 时间线分组大小，只针对指标查询有效
query.soffset integer 时间线分组偏移量
query.limit integer 分页大小
query.offset integer 分页偏移量
query.orderby array 排序列表，结构为 {fieldName: method}；指标集查询只支持 fieldName=time，method 可选 desc、asc
query.sorderby array 排序列表，sorderby 的 column 是一个表达式，支持所有返回单个值的聚合函数min max last avg p90 p95 count, {fieldName:method},结构和orderby一致
query.order_by array Doris 引擎兼容排序列表，结构为 [{"column": "field", "order": "DESC"}]
query.sorder_by array Doris 引擎兼容时间线排序列表，结构为 [{"column": "field", "order": "DESC"}]
query.density string 响应的点密度, 优先级小于 autoDensity 且大于 dql语句中设置的密度
query.interval number 时间分片间隔，只接受可转换为 Kodo int64 范围内且不小于 1ms 整数毫秒的正数；默认单位为秒，可通过 interval_unit 指定为毫秒
query.interval_unit string interval 的单位，可选 s、ms，默认 s
query.align_time boolean 是否按查询引擎时间网格对齐时间分片，默认 false
query.tz string 查询时区，默认 Asia/Shanghai
query.search_after array 分页标记, 由当前接口返回的分页标记，用于下一次请求时传入
query.maxPointCount integer 最大点数
query.workspaceUUID string 要查询的单个授权方工作空间 UUID；* 表示查询 targetRegion 内全部已授权空间
query.workspaceUUIDs array 要查询的授权方工作空间 UUID 列表；非空时优先于 query.workspaceUUID。同一列表必须属于同一个站点；["*"] 表示查询 targetRegion 内全部已授权空间。建议不要同时传两个字段
query.targetRegion string 授权方工作空间所属站点的 regionCode；显式跨站点查询建议传入，查询 * 时必须传入
query.output_format string lineprotocol: 行协议输出，默认不填的话，默认保持现有输出格式不变
query.cursor_time integer 分段查询阈值：第一次分段查询时设置为 end_time；之后传入响应中的 next_cursor_time
query.cursor_token string 分页查询token(由引擎返回 cursor_token 的值): 分页查询时，需要将上次查询返回的 next_cursor_token 设置为本次查询的 cursor_token；不带 cursor_token 的请求可能会造成翻页时相同时间戳的数据被跳过。
query.disable_sampling bool 采样禁用开关, 默认值为 false
query.disable_truncate bool 是否禁用返回内容截断，默认 false，表示允许截断
  • 响应点密度density 参数值说明 *
可选值 说明
lower 较低，60个点
low 低，180个点
medium 中等，360个点
high 高，720个点
  • 注意点密度参数的优先级，最大密度density[high] * maxPointCount > interval > density > dql语句中的控制参数

3、 常见查询说明

响应

文档评价

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