跳转到主要内容
ZStack
监控与采集相关接口/监控查询与概览

构建查询

构建结构化监控查询字段等级参数返回已渲染PROM QL SQL表单。

POST/api/v1/monitoring/query-builder/build

操作 ID

BuildQuery

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • metric
    String必填

    指标名称。

    示例： cpu_usage_percent

  • filters
    LinkedHashMap必填

    过滤条件列表。

    示例： (nested object)

  • condition
    String必填

    条件表达式。

    示例： resource_type='vm'

  • timeRange
    String必填

    时间范围。

    示例： 1h

  • aggregation
    String必填

    聚合方式。

    示例： avg

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • sqlLike
    String

    SQL风格表示。

    示例： SELECT avg(cpu_usage_percent) FROM metrics WHERE resource_type='vm'

  • promql
    String

    生成的 PromQL 查询语句。

    示例： avg(cpu_usage_percent{resource_type="vm"})

  • valid
    Boolean

    是否有效。

    示例： true

  • error
    String

    错误码。操作成功时为 null，失败时返回具体错误信息。

    示例： connection refused