跳转到主要内容
API Explorer|API Explorer
监控与采集相关接口/监控查询与概览
POSTMonitoring起始版本 1.0同步需要认证

构建查询

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • metricString必填

    指标名称。

    示例： cpu_usage_percent

  • filtersLinkedHashMap必填

    过滤条件列表。

    示例： (nested object)

  • conditionString必填

    条件表达式。

    示例： resource_type='vm'

  • timeRangeString必填

    时间范围。

    示例： 1h

  • aggregationString必填

    聚合方式。

    示例： avg

响应状态

200 OK

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

  • sqlLikeString

    SQL风格表示。

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

  • promqlString

    生成的 PromQL 查询语句。

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

  • validBoolean

    是否有效。

    示例： true

  • errorString

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

    示例： connection refused

请求地址

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

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

操作 ID

BuildQuery

永久链接

请求示例

curl -X POST '{host}/api/v1/monitoring/query-builder/build' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"metric":"cpu_usage_percent","filters":"(nested object)","condition":"resource_type='vm'","timeRange":"1h","aggregation":"avg","groupBy":"item1,item2"}'

响应示例

200
{
  "sqlLike": "SELECT avg(cpu_usage_percent) FROM metrics WHERE resource_type='vm'",
  "promql": "avg(cpu_usage_percent{resource_type=\"vm\"})",
  "valid": true,
  "error": "connection refused"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史