跳到正文

GET /api/ping

轻量的健康检查端点。Function App 正常运行时,会返回 200 和一个很小的 JSON 响应体。无需认证请求头,适合用于在线监控和 CI 冒烟测试。

请求

响应

{
  "status": "ok",
  "service": "qr-branding",
  "version": "1.6.2",
  "now": "2026-05-24T08:14:31Z"
}
  • status:只要函数执行,就始终为 "ok"。如果函数没有执行,你得到的会是连接错误,而不是 JSON 响应体。
  • version:已部署引擎的语义化版本号。
  • now:UTC 服务器时钟。可用于确认你的 X-Internal-Ts 签名没有出现时间漂移。

使用场景

  • 在线监控:每 60 秒调用一次 /api/ping;非 200 时告警。
  • CI 冒烟测试:每次部署后,如果 version 与刚推送的标签不一致,就让流水线失败。
  • 时钟偏差检查:调试内部 BFF 返回的 401 INVALID_SIGNATURE 时,将 now 与客户端时钟进行比较(TTL 为 60 秒;偏差超过 90 秒会导致 HMAC 失败)。

它不检查什么

ping 有意保持轻量。它不验证:

  • 数据库是否可达。
  • LLM 提供商是否有响应。
  • 你的 RapidAPI / 内部认证请求头是否配置正确。

如需更深入的检查,请用最小载荷(仅 content)调用 /api/qr/generate,并确认二维码能正常返回。