文档目录

健康检查

GET /api/health 返回服务与各组件的运行状态,用于监控与探活。

GET /api/health

返回服务运行状态,用于监控与探活。端点公开,无参数,响应头固定为 cache-control: no-store。

全部组件正常时返回 200;任一组件异常时返回 503,并在 components 中标出具体降级的组件。

curl https://hypoark.com/api/health

响应

{
  "status": "ok",
  "service": "citeark-web",
  "revision": "citeark-00042-abc",
  "components": {
    "database": { "status": "ok", "latencyMs": 12 },
    "objectStorage": { "status": "ok", "latencyMs": 30 },
    "authentication": { "status": "ok" },
    "configuration": { "status": "ok" },
    "signing": { "status": "ok" }
  },
  "checkedAt": "2026-01-01T00:00:00.000Z"
}
字段 说明
status 整体状态:ok 或 degraded(对应 HTTP 200 / 503)
service 固定为 citeark-web
revision 当前部署版本
components 各组件健康状态,见下表
checkedAt 本次检查的 ISO 时间

components 包含五个组件,每个组件都有 status(ok 或 failed):

组件 说明
database PostgreSQL 连接与数据库迁移版本检查,附带 latencyMs,失败时附 detail
objectStorage R2 对象存储连接检查,附带 latencyMs,失败时附 detail
authentication 登录与邮件等认证相关环境变量是否齐备
configuration 生产环境配置是否完整
signing artifact 签名密钥(KMS 或私钥)是否配置

备注

此端点只做依赖连通性与配置检查,不代表业务功能全部可用;503 响应同样是有效的健康检查信号,监控方应按状态码与 status 字段告警。