Status
GET
/api/v1/status返回公开目标、当前状态、SLA 汇总、事件、前端外观配置、Ping 目标与最新 Agent 遥测,是替代前端的主要入口。
查询参数
| 参数 | 必填 | 默认 | 范围 | 说明 |
|---|---|---|---|---|
days | 否 | 服务端默认 | 1–90 | 日汇总与 SLA 展示跨度 |
lite | 否 | 0 | 0 或 1 | 1 返回适合首屏的精简数据 |
bash
curl -fsSL 'https://YOUR-API/api/v1/status?days=30&lite=1'顶层字段
| 字段 | 说明 |
|---|---|
name | 公开站点名称 |
now | 服务端生成响应的 ISO 时间 |
days | 当前返回的日期列表 |
regions | 区域代码到显示名称的映射 |
region_proxy_enabled | 是否绑定区域 Durable Object |
frontend_theme | 内置前端主题名称 |
frontend | 公开过滤后的主题与外观设置 |
traffic | 当前默认流量周期说明 |
privacy | IP、端口与机房信息的公开策略 |
storage | 当前公开状态/历史存储能力与缓存 TTL |
timezone | SLA 聚合使用的时区 |
targets[] | 目标资料、当前探测、Agent 状态与延迟来源 |
summaries[] | 每目标每日 SLA 聚合 |
incidents[] | 最近故障与恢复事件 |
ping_targets[] | 已启用的 Agent TCP Ping 目标 |
warnings[] | 非致命同步或数据警告 |
targets[] 关键字段
id、name、group_name、type:稳定标识与分类。location、city、provider、line_type:公开展示资料。ok、checked_at、latency_ms:Cloudflare 当前探测。agent_online、last_metrics_at、agent_version:Rust Agent 状态。agent_metrics:公开过滤后的最新系统指标。latency_sources[]:Cloudflare 与 stale 窗口内的外部来源。has_nq、nq:NodeQuality 报告是否存在与更新时间。unlock:IPv4 解锁检查保存的脱敏服务结果。no_public_ip:启用后不公开目标 IP、端口与主动延迟数据。
ok 表示 Cloudflare 主动探测,agent_online 表示指标 Agent 最近上报。二者分别显示,不要用一个覆盖另一个。
agent_metrics.vps_info.total_disk_gb 是系统根文件系统容量,不是所有挂载点之和;同设备绑定挂载不重复计入。
精简模式
首屏请求 lite=1,详情打开后再按需读取 checks、metrics、pings 或 latency。精简模式保留目标、汇总、事件、隐私、外观与警告,但移除目标日明细与 agent_metrics.pings 等重字段。
时间与排序
服务端时间可能与客户端不同。计算“刚刚上报”时用响应中的 now 作参考;历史数组按数字时间戳显式排序。
隐私处理
服务端按部署设置掩码 IP、隐藏端口、移除 URL 凭据与内部错误细节。客户端不要尝试从其他公开字段还原这些信息,也不要用管理 API 数据代替公开状态。
启用 no_public_ip 的 TCP 目标隐藏 Cloudflare 当前探测与外部 Latency,status_source 转为 Agent,ok/checked_at/latency_ms 可为 null。此时只展示 Agent 在线状态,不要把 null 解释为故障。
缓存与警告
默认状态缓存约 20 秒,部署者可在 0–300 秒调整。公开 v1 不能用 fresh=1 绕过缓存;只有携带有效管理员 Session 的内部状态请求允许强制刷新。warnings[] 表示部分可选来源退化,主体目标仍可渲染。