跳转到主要内容
POST
/
monit
/
query
/
rows
查询数据源原始行
curl --request POST \
  --url 'https://api.flashcat.cloud/monit/query/rows?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": 10001,
  "ds_type": "prometheus",
  "ds_name": "prod-prom",
  "expr": "up",
  "delay_seconds": 30
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": [
    {
      "fields": {
        "__name__": "up",
        "instance": "10.0.0.1:9100",
        "job": "node"
      },
      "values": {
        "__value__": 1
      }
    }
  ]
}

​
调用限制

项值
速率限制600 次/分钟;10 次/秒 每账户
权限任意有效的 app_key(只读;不受特定权限分类约束)

​
使用说明

  • 请求通过 WebSocket 转发至 monit-edge;ds_type + ds_name 指定的数据源必须已在调用方账户下存在。
  • 请求体中的 account_id 为可选;若提供,必须与已认证账户一致,否则拒绝。
  • 存在两层错误:webapi 层失败使用标准错误信封返回,而 monit-edge 执行查询时抛出的错误以 HTTP 200 返回,并在响应体中携带 error 对象。除 HTTP 状态外,务必同时检查响应体中的 error。
  • monit-edge 强制行数上限;过大结果集会返回 error.message = "too many rows"。请收窄时间范围或在数据源端聚合。
  • args 是一个多态 string→string 映射,原样转发。语义取决于 ds_type(SLS 需要 sls.project + sls.logstore;Loki / VictoriaLogs 原始模式需要通过 *.start/*.end 或 *.timespan.value/*.timespan.unit 指定时间范围;Prometheus 与 SQL 类数据源忽略该字段)。各数据源的键列表见 monit-webapi query-api 文档。

授权

​
app_key
string
query
必填

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

请求体

application/json
​
ds_type
string
必填

数据源类型;必须匹配租户下已配置的数据源。示例:prometheus、loki、victorialogs、sls、elasticsearch、mysql、postgres、oracle、clickhouse。

​
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。所有值必须为字符串。语义取决于 ds_type:SLS 需要 sls.project + sls.logstore;Loki / VictoriaLogs 原始模式需要通过 <source>.start/<source>.end 或 <source>.timespan.value + <source>.timespan.unit 指定时间范围;Prometheus 与 SQL 类数据源忽略该字段。键务必按数据源命名空间区分(如 sls.project、loki.type)。

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object[]
必填

结果行。不同数据源对 fields 与 values 的填充方式不同——指标类数据源(Prometheus、*-stats)将数字放入 values;明细类数据源(SQL、SLS、原始日志)将数据放入 fields,values 可能为 null。