对于最新稳定版本,请使用Spring Boot 4.0.0spring-doc.cadn.net.cn

健康(健康)

健康端点提供关于应用健康状况的详细信息。spring-doc.cadn.net.cn

检索应用程序的健康状态

要检索应用程序的健康状况,请设置获取请求/执行器/健康如以下基于卷度的示例所示:spring-doc.cadn.net.cn

$ curl 'http://localhost:8080/actuator/health' -i -X GET \
    -H 'Accept: application/json'

最终的响应类似于以下内容:spring-doc.cadn.net.cn

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 821

{
  "status" : "UP",
  "components" : {
    "broker" : {
      "status" : "UP",
      "components" : {
        "us1" : {
          "status" : "UP",
          "details" : {
            "version" : "1.0.2"
          }
        },
        "us2" : {
          "status" : "UP",
          "details" : {
            "version" : "1.0.4"
          }
        }
      }
    },
    "db" : {
      "status" : "UP",
      "details" : {
        "database" : "H2",
        "validationQuery" : "isValid()"
      }
    },
    "diskSpace" : {
      "status" : "UP",
      "details" : {
        "total" : 76887154688,
        "free" : 51270258688,
        "threshold" : 10485760,
        "path" : "/home/runner/work/spring-boot/spring-boot/spring-boot-project/spring-boot-actuator-autoconfigure/.",
        "exists" : true
      }
    }
  }
}

响应结构

回复包含应用健康状况的详细信息。 下表描述了该反应的结构:spring-doc.cadn.net.cn

路径 类型 描述

地位spring-doc.cadn.net.cn

字符串spring-doc.cadn.net.cn

申请的整体状态。spring-doc.cadn.net.cn

组件spring-doc.cadn.net.cn

对象spring-doc.cadn.net.cn

构成健康的组成部分。spring-doc.cadn.net.cn

组件。*.状态spring-doc.cadn.net.cn

字符串spring-doc.cadn.net.cn

申请中某个具体部分的状态。spring-doc.cadn.net.cn

components.*.componentsspring-doc.cadn.net.cn

对象spring-doc.cadn.net.cn

组成生命值的嵌套组件。spring-doc.cadn.net.cn

组件。*.细节spring-doc.cadn.net.cn

对象spring-doc.cadn.net.cn

申请中特定部分的健康状况细节。在线状态由以下方式控制管理。端点。健康。显示-详情.spring-doc.cadn.net.cn

上面的响应字段是针对V3 API的。 如果你需要返回 V2 JSON,应该使用接受头,或者application/vnd.spring-boot.actuator.v2+JSON

恢复组件的健康状态

要获取应用程序健康状态中某一特定组件的健康状态,请设置获取请求/actuator/health/{component}如以下基于卷度的示例所示:spring-doc.cadn.net.cn

$ curl 'http://localhost:8080/actuator/health/db' -i -X GET \
    -H 'Accept: application/json'

最终的响应类似于以下内容:spring-doc.cadn.net.cn

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 101

{
  "status" : "UP",
  "details" : {
    "database" : "H2",
    "validationQuery" : "isValid()"
  }
}

响应结构

响应包含应用健康中某一特定组件的健康状况细节。 下表描述了该反应的结构:spring-doc.cadn.net.cn

路径 类型 描述

地位spring-doc.cadn.net.cn

字符串spring-doc.cadn.net.cn

申请中特定部分的状态spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

对象spring-doc.cadn.net.cn

申请中特定部分的健康状况细节。spring-doc.cadn.net.cn

获取嵌套组件的健康状态

如果某个特定组件包含其他嵌套组件(如代理上述示例中的指示符),可以通过发出获取请求/actuator/health/{component}/{subcomponent}如以下基于卷度的示例所示:spring-doc.cadn.net.cn

$ curl 'http://localhost:8080/actuator/health/broker/us1' -i -X GET \
    -H 'Accept: application/json'

最终的响应类似于以下内容:spring-doc.cadn.net.cn

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 66

{
  "status" : "UP",
  "details" : {
    "version" : "1.0.2"
  }
}

应用程序健康状态的组成部分可能根据应用程序的健康指标及其分组方式,嵌入任意深度。 健康端点支持任意数量的/{组件}URL中的标识符,允许在任何深度检索组件的健康状态。spring-doc.cadn.net.cn

响应结构

响应包含应用中某一特定组件实例的健康状况细节。 下表描述了该反应的结构:spring-doc.cadn.net.cn

路径 类型 描述

地位spring-doc.cadn.net.cn

字符串spring-doc.cadn.net.cn

申请中特定部分的状态spring-doc.cadn.net.cn

spring-doc.cadn.net.cn

对象spring-doc.cadn.net.cn

申请中特定部分的健康状况细节。spring-doc.cadn.net.cn