query struct to promql

Changed on Feb 28, 2024

post/query/ts/struct_to_promql

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
URL
/query/ts/struct_to_promql
Auth
none declared

Headers

traceparentstring

TraceID

Bk-Query-Sourcestring

来源

X-Bk-Scope-Space-Uidstring

空间UID

Request body

add_dimensionsstring[]

AddDimensions 额外添加的聚合维度，会与每个 function.dimensions 合并

clear_cacheboolean

ClearCache 是否强制清理已存在的缓存会话

down_sample_rangestring

DownSampleRange 降采样：大于Step才能生效，可以为空

dry_runboolean

DryRun 是否启用 DryRun

end_timestring

End 结束时间：单位为任意长度的时间戳

frominteger

From 翻页起始位置；Doris SearchAfter 缺少稳定游标字段时会降级为 offset 分页

instantboolean

Instant 瞬时数据

is_es_batchboolean

IsESBatch 是否启用 query_raw 的 ES 批量查询

is_merge_dbboolean

IsMergeDB 是否启用合并 db 特性

is_multi_fromboolean

IsMultiFrom 是否启用 MultiFrom 查询

is_search_afterboolean

IsSearchAfter 是否启用 SearchAfter 查询。仅用于 /query/raw 原始查询：Elasticsearch 使用原生游标；Doris 优先使用 unique_key，缺少时尝试 dtEventTimeStamp、gseIndex、iterationIndex 组合游标，再缺少时降级为 offset 分页；不能与 scroll 同时使用。

legacy_output_refstring

LegacyOutputRef 指向与 MetricMerge 等价的输出，供旧服务兼容降级。

limitinteger

增加公共限制 Limit 点数限制数量

look_back_deltastring

LookBackDelta 偏移量

metric_mergestring

MetricMerge 表达式：支持所有PromQL语法

not_time_alignboolean

NotTimeAlign 查询开始时间和聚合是否需要对齐例如 true: range: 10:03 - 10:23 window: 10m -> 10:03 - 10:13, 10:13 - 10:23 false: range: 10:03 - 10:23 window: 10m -> 10:00 - 10:10, 10:10 - 10:20, 10:20 - 10:23

order_bystring[]

OrderBy 排序字段列表，按顺序排序，负数代表倒序, ["_time", "-_time"]

referenceboolean

Reference 查询开始时间是否需要对齐，例如： true: range: 10:03 - 10:23 window: 10m -> 10:03 - 10:10, 10:10 - 10:20, 10:20 - 10:23 false: range: 10:03 - 10:23 window: 10m -> 10:00 - 10:10, 10:10 - 10:20, 10:20 - 10:23

response_contract'named_outputs/v1'

ResponseContract 显式选择命名多输出响应契约；为空时保持旧单输出行为。

result_table_optionsMetadataResultTableOptions

scrollstring

Scroll 是否启用 Scroll 查询

slice_maxinteger

SliceMax 最大切片数量

space_uidstring

SpaceUid 空间ID

start_timestring

Start 开始时间：单位为任意长度的时间戳

stepstring

Step 步长：最终返回的点数的时间间隔

timezonestring

Timezone 时区

tsdb_mapobject

TsDBMap 查询路由匹配中的 tsDB 列表 key:reference_name

Example request

{
  "down_sample_range": "5m",
  "end_time": "1657851600",
  "legacy_output_ref": "C",
  "metric_merge": "a",
  "output_list": [
    {
      "expression": "A",
      "reference_name": "A"
    }
  ],
  "query_list": [
    {
      "conditions": {
        "condition_list": [
          "and"
        ],
        "field_list": [
          {
            "field_name": "bk_biz_id",
            "op": "contains",
            "value": [
              "2"
            ]
          }
        ]
      },
      "dimensions": [
        "bk_target_ip",
        "bk_target_cloud_id"
      ],
      "field_name": "usage",
      "function": [
        {
          "dimensions": [
            "bk_target_ip",
            "bk_target_cloud_id"
          ],
          "field": "field",
          "method": "mean",
          "window": "60s"
        }
      ],
      "reference_name": "a",
      "table_id": "system.cpu_summary",
      "table_id_conditions": [
        [
          {
            "field_name": "bk_biz_id",
            "op": "contains",
            "value": [
              "2"
            ]
          }
        ]
      ],
      "time_aggregation": {
        "function": "avg_over_time",
        "window": "60s"
      }
    }
  ],
  "response_contract": "named_outputs/v1",
  "start_time": "1657848000",
  "step": "1m",
  "timezone": "Asia/Shanghai"
}

Response

add_dimensionsstring[]

AddDimensions 额外添加的聚合维度，会与每个 function.dimensions 合并

bk_biz_idsstring[]

down_sample_rangestring

DownSampleRange 降采样：大于Step才能生效，可以为空

endstring

instantboolean

瞬时数据

is_verify_dimensionsboolean

limitinteger

look_back_deltastring

LookBackDelta 偏移量

matchstring

max_source_resolutionstring

not_align_influxdbboolean

不与influxdb对齐

not_time_alignboolean

promqlstring

referenceboolean

slimitinteger

startstring