跳转到主要内容
ZStack
平台运维相关接口/平台健康

获取聚合健康度

获取当前聚合健康状态监控组件。

GET/api/v1/health

操作 ID

GetAggregateHealth

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

此接口无需请求参数。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • overallStatus
    String

    整体系统健康度状态健康降级不健康。

    示例： healthy

  • components
    List

    个体组件健康度状态。

    示例： (nested array)

    • component
      String

      组件。

      示例： database

    • status
      String

      状态信息。

      示例： healthy

    • latencyMs
      String

      时延，单位为毫秒。

      示例： 5

    • message
      String

      错误返回消息。

      示例： All queries responding normally

    • checkedAt
      String

      检查时间。

      示例： 2026-01-15T08:00:00Z

  • checkedAt
    String

    检查时间。

    示例： 2026-01-15T08:00:00Z