執行健康狀態檢查

本頁適用於 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 Proxy，藉此執行環境層級的健康狀態檢查，方法是按照下列方式建構要求：

  • 在 Proxy 基礎路徑前方加上 /healthz/。
  • 新增要求標頭：User-Agent: GoogleHC。

舉例來說，假設 /catalog 是已部署至環境中的有效 Proxy 基礎路徑。如要進行健康狀態檢查，請呼叫 Proxy，如下所示：

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
，其中 $HOST 代表負載平衡器提供的 Apigee 環境群組中定義的主機名稱。

透過 API Proxy 執行自訂健康狀態檢查

如果您想執行其他驗證，可以在部署至環境的 API Proxy 中定義自訂健康狀態檢查邏輯。舉例來說，如果有多個環境發生異常，您可能會失敗。或者，您可以根據目標健康狀態或延遲時間，讓健康狀態檢查失敗。

在這種情況下，您可以對該 proxy 執行一般 API 呼叫來執行健康狀態檢查。

舉例來說，假設您要檢查名為 prod 的環境健康狀態。將 API Proxy 部署至含有 basepath /healthcheck-prod 的環境。如要檢查 Apigee 執行個體提供的 prod 環境健康狀態，請呼叫 Proxy，如下所示：

$ curl https://$HOST/healthcheck-prod
，其中 $HOST 代表負載平衡器提供的 Apigee 環境群組中定義的主機名稱。

使用須知

區域層級和環境層級健康檢查：如果是由 Google Cloud 負載平衡器執行，負載平衡器會設定正確的 User-Agent 標頭。如果您自己的用戶端會使用這些健康檢查 API 呼叫，請務必設定正確的 User-Agent。

Apigee hybrid：健康狀態檢查功能僅適用於 1.4 以上版本。