Health (health)

QWen Max 中英对照 Health (health) Health (health)

health 端点提供有关应用程序健康状况的详细信息。

检索应用程序的健康状况

要获取应用程序的健康状况，请向 /actuator/health 发起一个 GET 请求，如下列基于 curl 的示例所示：

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

得到的响应类似于以下内容：

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" : 48479952896,
        "threshold" : 10485760,
        "path" : "/home/runner/work/spring-boot/spring-boot/spring-boot-project/spring-boot-actuator-autoconfigure/.",
        "exists" : true
      }
    }
  }
}

响应结构

响应包含应用程序健康状况的详细信息。下表描述了响应的结构：

路径	类型	描述
status	String	应用程序的整体状态。
components	Object	构成健康状况的各个组件。
components.*.status	String	应用程序特定部分的状态。
components.*.components	Object	构成健康状况的嵌套组件。
components.*.details	Object	应用程序特定部分的健康状况详情。其是否存在由 management.endpoint.health.show-details 控制。

备注

上述响应字段适用于 V3 API。如果你需要返回 V2 JSON，应使用 accept header 或 application/vnd.spring-boot.actuator.v2+json

检索组件的健康状况

要获取应用程序健康状况中特定组件的健康信息，请向 /actuator/health/{component} 发起一个 GET 请求，如下列基于 curl 的示例所示：

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

得到的响应类似于以下内容：

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

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

响应结构

响应包含应用程序健康状况中某个特定组件的健康详情。下表描述了该响应的结构：

Path	Type	Description
status	String	应用程序特定部分的状态
details	Object	应用程序特定部分的健康状况详情。

检索嵌套组件的健康状况

如果某个特定组件包含其他嵌套组件（如上面示例中的 broker 指示器），可以通过向 /actuator/health/{component}/{subcomponent} 发送 GET 请求来获取该嵌套组件的健康状态，如下列基于 curl 的示例所示：

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

得到的响应类似于以下内容：

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

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

应用程序健康状况的组件可能会根据应用程序的健康指标及其分组方式而任意深度嵌套。健康端点支持在 URL 中使用任意数量的 /{component} 标识符，以便检索任意深度的组件健康状况。

响应结构

响应包含应用程序某个组件实例的健康状况详情。下表描述了响应的结构：

Path	Type	Description
status	String	应用程序特定部分的状态
details	Object	应用程序特定部分的健康状况详情。