跳转到主要内容
POST
/
monit
/
preview
/
sync
同步预览数据源查询
curl --request POST \
  --url 'https://api.flashcat.cloud/monit/preview/sync?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ds_type": "prometheus",
  "ds_name": "生产 Prometheus",
  "expr": "rate(http_requests_total[5m])",
  "delay_seconds": 0
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "status": "success",
    "data": {
      "resultType": "vector",
      "result": []
    }
  }
}

​
限制说明

项目说明
速率限制每个账户 60 次/分钟；10 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

​
使用说明

  • ds_type 须与数据源类型匹配，如 prometheus、loki。
  • ds_name 为账户中配置的数据源显示名称。
  • delay_seconds 将查询窗口向前偏移指定秒数，用于补偿数据摄入延迟。
  • 响应体为数据源返回的原始 JSON，其结构随数据源类型而异。

授权

​
app_key
string
query
必填

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

请求体

application/json

同步数据源查询预览的参数。

​
ds_type
string
必填

数据源类型，如 prometheus、loki、elasticsearch。

​
ds_name
string
必填

账户中配置的数据源显示名称。

​
expr
string
必填

查询表达式，格式因 ds_type 而异（Prometheus 为 PromQL，Loki 为 LogQL 等）。

​
delay_seconds
integer

将查询窗口向前偏移的秒数，用于补偿数据摄入延迟。

​
args
object

特定类型的额外查询参数。

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

数据源返回的原始 JSON，结构随数据源类型而异。