跳到主要内容
版本:3.2.16.4.1

执行网关健康探测

在生产环境中,健康检查探测对于确保 API7 企业版的稳定性和可靠性至关重要。当请求先经过负载均衡器(LB)再到达 API7 网关时,负载均衡器可以依靠健康检查探测(例如网关提供的状态端点)监控网关的运行状态。负载均衡器可以通过这些探测判断网关实例是否健康、是否已准备好处理传入流量。如果某个实例被判定为不健康,负载均衡器会自动将请求重新路由到健康实例,以避免中断和停机。该机制通过维持服务连续性实现高可用性,降低将请求路由到无响应节点的风险,并改善整体用户体验。

本教程介绍如何启用健康检查探测,以及如何检查网关的存活和就绪状态。

启用健康检查探测​

默认情况下,状态探测未启用。要启用检查,请将以下配置添加到网关配置文件中。

config.yaml
apisix:
status:
ip: 0.0.0.0
port: 7085

❶ 网关在 Docker 中部署时,将监听 IP 配置为 0.0.0.0。未配置时回退到 127.0.0.1。请根据部署方式调整。

❷ 将监听端口配置为 7085。

启用后,网关会提供 /status 和 /status/ready 端点供健康检查探测使用。

检查网关运行状态​

/status 端点可用于验证网关是否成功启动并正在运行。例如,可以定期向网关发送以下请求。

curl "http://127.0.0.1:7085/status"

如果网关健康,应收到 200 OK 响应。如果网关不健康,则不会收到响应,也可能看到连接被拒绝。

检查网关是否已准备好处理流量​

/status/ready 端点可用于验证网关是否已准备好代理流量。例如,可以定期向网关发送以下请求。

curl "http://127.0.0.1:7085/status/ready"

如果网关已准备好代理流量,应收到 200 OK 响应。如果尚未就绪,应收到 503 Service Temporarily Unavailable 响应。

就绪状态由 DP Manager 报告的数据库节点可用性决定。至少一个数据库节点可用时,网关会返回 200 OK。没有任何数据库节点可用时,网关会返回 503 Service Temporarily Unavailable。

在 Kubernetes 中配置就绪探测​

如果使用 Kubernetes,可以通过就绪探测配置来检查网关是否就绪。在相应的清单文件中添加以下内容。

readinessProbe:
httpGet:
path: /status/ready
port: 7085
initialDelaySeconds: 5
periodSeconds: 5

❶ 设置为网关探测端点。

❷ 设置为网关探测端口。

❸ 在执行第一次探测前等待 5 秒。

❹ 每隔 5 秒执行一次探测。

有关更多信息,请参阅配置存活、就绪和启动探测。