跳转到主要内容
API Explorer|API Explorer
平台运维相关接口/平台健康
GETPlatform起始版本 1.0同步需要认证

获取聚合健康度

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • overallStatusString

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

    示例： healthy

  • componentsList

    个体组件健康度状态。

    示例： (nested array)

    • componentString

      组件。

      示例： database

    • statusString

      状态信息。

      示例： healthy

    • latencyMsString

      时延，单位为毫秒。

      示例： 5

    • messageString

      错误返回消息。

      示例： All queries responding normally

    • checkedAtString

      检查时间。

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

  • checkedAtString

    检查时间。

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

请求地址

GET/api/v1/health

/api/v1/health

操作 ID

GetAggregateHealth

永久链接

请求示例

curl -X GET '{host}/api/v1/health' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "overallStatus": "healthy",
  "components": [
    {}
  ],
  "checkedAt": "example"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史