执行健康检查

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

Apigee 在不同级层公开健康检查，您可以根据用例利用这些检查。

  1. 区域级/Apigee 实例健康检查：返回区域中整个 Apigee 实例的健康状况。
  2. 环境级层健康检查：返回 Apigee 实例中特定环境的健康状况。
  3. 通过 API 代理进行自定义健康检查：对于复杂的用例，您可以将专用 API 代理配置为自定义健康检查端点。

执行区域级健康检查

Apigee 提供区域级 / Apigee 实例健康检查，以评估特定区域中 Apigee 实例的整体健康状况。负载均衡器广泛使用的这种健康检查模式决定了 Apigee 实例的健康状况，并执行区域级故障切换。您可以通过按如下方式构造请求来执行区域级健康检查：

  • 健康检查路径：/healthz/ingress
  • 添加请求标头：User-Agent: GoogleHC。
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy
其中，$HOST 表示在负载均衡器提供的 Apigee 环境组中定义的主机名。

执行环境级层健康检查

Apigee 提供环境级层的健康检查，以评估 Apigee 实例提供的特定环境的健康状况。如果要根据某些关键/选择环境的运行状况执行区域级故障切换，首选此健康检查模式。您可以通过在环境中调用任何有效 API 代理来执行环境级层的健康检查，方法是按如下所示构造请求：

  • 将 /healthz/ 附加到代理基本路径。
  • 添加请求标头：User-Agent: GoogleHC。

例如，假设 /catalog 是部署在环境中的有效代理基本路径。如需执行健康检查，请按以下方式调用代理：

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
其中，$HOST 表示在负载均衡器提供的 Apigee 环境组中定义的主机名。

通过 API 代理执行自定义健康检查

如果要执行任何其他验证，您可以在部署到环境的 API 代理中定义自定义健康检查逻辑。例如，当多个环境关闭时，您可能无法执行健康检查。或者，根据目标健康状况或延迟时间，您可能无法执行健康检查。

在这种情况下，您可以通过对该代理进行常规 API 调用来执行健康检查。

例如，假设您要查看名为 prod 的环境的运行状况。使用基本路径 /healthcheck-prod 将 API 代理部署到该环境。如需检查 Apigee 实例提供的 prod 环境的运行状况，请按以下方式调用代理：

$ curl https://$HOST/healthcheck-prod
其中，$HOST 表示在负载均衡器提供的 Apigee 环境组中定义的主机名。

使用说明

对于区域级和环境级健康检查：如果它们由 Google Cloud 负载均衡器执行，则负载均衡器设置了正确的 User-Agent 标头。如果您的客户端使用自己的这些健康检查 API 调用，您需要确认设置了正确的 User-Agent。

对于 Apigee Hybrid：健康检查功能仅适用于 1.4 及更高版本。