Skip to main content
POST

​
限制说明

通过 /monit/datasource/list 获取数据源 ID。停用数据源返回 datasource_disabled，alerting_enabled=false 不阻断工具。错误使用非 2xx HTTP 状态和 error.code、error.message、error.reason。tool_not_supported 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。

​
使用说明

  • 本入口共用两类工具：由执行端 Edge 定义的诊断工具（如 mysql.overview、prometheus.metric_trends）和命名为 <type>.query 的查询工具。工具前缀必须与数据源类型一致。
  • 查询工具要求 Edge 集群支持 Explore 查询（协议里程碑 v0.68.0）；诊断工具要求 v0.71.0 基础 invoke 协议。不支持的集群返回 edge_upgrade_required、mixed_edge_versions 或 edge_version_unknown；禁止自动回退 /monit/query/data 或其他接口。
  • 查询工具的 params 遵循 tool 字段描述中按数据源列出的专属 Schema。expr 和 execution 必填。limit/direction 只约束原始日志条数与检索方向，不代表 SQL 行数或扫描量。未知扩展字段被容忍，但不参与执行也不透传。
  • 查询结果的 data 是完整 Explore 结果：format 为 explore_result.v1，result.kind 为 samples、frames 或 logs；日志结果保留 applied_limit 和 has_more。查询结果不合成 summary 或 truncated。
  • 请求体上限 128 KiB；两类工具的完整成功响应上限均为 10 MiB；诊断工具超时最多 25 秒。

授权

​
app_key
string
query
必填

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

请求体

application/json
​
datasource_id
integer<uint64>
必填

通过 /monit/datasource/list 获取的数据源 ID。

必填范围: x >= 1
​
tool
string
必填

以数据源类型为前缀的单个工具名。诊断工具由执行端 Edge 定义（如 mysql.overview）。查询工具为 <type>.query，<type> 取 prometheus、mysql、postgres、oracle、clickhouse、elasticsearch、loki、victorialogs、sls、tencent_cls 之一；params 分别遵循 PrometheusQueryParams、MySQLQueryParams、PostgresQueryParams、OracleQueryParams、ClickHouseQueryParams、ElasticsearchQueryParams、LokiQueryParams、VictoriaLogsQueryParams、SLSQueryParams、TencentCLSQueryParams。

Required string length: 1 - 128
​
account_id
integer<uint64>

可选一致性检查，必须等于认证账户。

​
params
object

工具专属 JSON 参数；省略等同于 {}。显式 null 非法。查询工具（<type>.query）使用 tool 描述中按数据源列出的专属参数 Schema。

响应

成功

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

​
request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。