Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

ParseSQLStyleQuery

Parse a SQL-style query string into a structured QueryBuilderRequest object

POST/api/v1/monitoring/query-builder/parse-sql

Operation ID

ParseSQLStyleQuery

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • sqlQuery
    StringRequired

    SQL-style query string to parse into a structured query object

    Example: SELECT avg(cpu_usage_percent) FROM metrics WHERE resource_type='vm' LAST 1h

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • metric
    String

    Metric name to query

    Example: cpu_usage_percent

  • filters
    LinkedHashMap

    Filter criteria to narrow down results

    Example: (nested object)

  • condition
    String

    Filter condition expression (e.g. resource_type='vm')

    Example: resource_type='vm'

  • timeRange
    String

    Query time range (e.g. 1h, 24h)

    Example: 1h

  • aggregation
    String

    Aggregation function (e.g. avg, max, p99)

    Example: avg

  • groupBy
    List

    Group by

    Example: item1,item2