Skip to main content
POST
查询结构化数据

调用限制

使用说明

  • 此公开接口以 monit-edge v0.65.0 为最低受支持版本。迁移期间,WebAPI 仍保留旧版 Edge 适配器:query.v2 结果仍可能保留 frames、records 或 samples,而 legacy rows 只能提供其已保留的信息。这些适配器不会改变最低支持版本;旧协议缺少 query.v3 的取消和错误生命周期语义,legacy rows 已丢失的数据也无法恢复。
  • 公开响应格式固定为 query_result.v1,与 Edge 内部查询协议版本无关。必须根据 result.kindframesrecordssamples)分发结果,不要根据 ds_type 或 Edge 版本猜测结果形态。
  • frames 结果可以包含多个表格或时序 Frame。字段值按列组织,同一 Frame 中所有字段的值数量一致。
  • records 结果可以包含嵌套 JSON 和 null record。超出 JavaScript 安全整数范围的整数字面量会以十进制字符串返回。
  • samples 结果包含标签集合和瞬时值。值可以是数字,也可以是字符串 NaN+Inf-Inf
  • 最终成功响应上限为 8 MiB,查询结果上限为 1,000 行。超限时请缩短时间范围、减少字段或在数据源侧聚合。
  • 查询失败使用非 2xx HTTP 状态码和标准错误 envelope。不要透明回退到已弃用的 /monit/query/rows 接口。
  • WebAPI 跨实例转发和 Edge 执行合计可能耗时 35 秒。客户端超时建议至少设为 40 秒,并在调用方放弃查询时向下传播取消信号。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

稳定结构化查询接口的请求。字段与已弃用的 rows 接口一致。

ds_type
string
必填

数据源类型;必须匹配租户下已配置的数据源。示例:prometheuslokivictorialogsslselasticsearchmysqlpostgresoracleclickhouse

ds_name
string
必填

数据源名称;必须匹配租户下已配置的数据源。

expr
string
必填

查询表达式。语法取决于 ds_type,由对应的 monit-edge 客户端解释(Prometheus 用 PromQL,Loki 用 LogQL,SQL 类数据源用 SQL,等等)。

account_id
integer<int64>

可选的一致性校验。若提供,必须等于已认证账户;不一致将被拒绝。业务执行始终使用已认证账户。

delay_seconds
integer
默认值:0

应用于点查询(Prometheus、Loki stats、VictoriaLogs stats)的回看偏移,单位秒。明细 / raw 查询忽略该字段。

args
object

透传给 monit-edge 的多态键值扩展参数。所有值必须是字符串,键一律按数据源加前缀(如 sls.projectloki.type)。校验规则取决于 ds_type:SLS 必须提供 sls.projectsls.logstore;Elasticsearch 的 es.type 只接受 sql 或不传,其他值一律拒绝;Loki 与 VictoriaLogs 的 <source>.type 接受 statsraw 或不传,其中 raw 还必须给出时间范围——<source>.start + <source>.end,或 <source>.timespan.value + <source>.timespan.unit(单位取 s/m/h/d)。Prometheus 及其余 SQL 类数据源完全忽略 args

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

与 Edge 版本无关的稳定结构化查询响应。