ヘルスチェックを使用する

Google Cloud にはヘルスチェックのメカニズムがあり、バックエンドインスタンスがトラフィックに適切に反応しているかどうかが判定されます。このドキュメントでは、ロードバランサと Cloud Service Mesh のヘルスチェックを作成および使用する方法について説明します。

このページでは、次のコンセプトを理解していることを前提としています。

ヘルスチェックを作成する

Google Cloud では、Google Cloud コンソールでロードバランサのバックエンド構成の完了時にヘルスチェックを作成または選択できます。

また、ロードバランサの構成とは別に Google Cloud コンソールでヘルスチェックを作成することもできます。これは、最初にヘルスチェックを作成する必要がある場合や、複数のロードバランサで同じヘルスチェックを使用する必要がある場合に実用的です。ヘルスチェックの作成には、Google Cloud コンソール、Google Cloud CLI、または REST API を使用できます。

コンソール

Google Cloud コンソールの [ヘルスチェック] ページに移動します。
[ヘルスチェック] ページに移動
[ヘルスチェックを作成] をクリックします。
ヘルスチェックの作成ページで、次の情報を入力します。
- 名前: ヘルスチェックの名前を指定します。
- 説明: 必要に応じて、説明を入力します。
- スコープ: ロードバランサの種類に応じて、グローバルまたはリージョンのスコープを選択します。
  - [リージョン] を選択した場合は、プルダウンから [リージョン] を選択します。
- プロトコル: ヘルスチェックプロトコルを選択します。
- ポート: ポート番号を指定します。Google Cloud コンソールでヘルスチェックを作成する場合は、ポート番号を使用してポートを指定する必要があります。
- プロキシプロトコル: 必要に応じてヘルスチェックプローブシステムから送信されたリクエストにプロキシヘッダーを追加できます。
- リクエストパスとレスポンス: HTTP、HTTPS、HTTP2 のプロトコルの場合は、必要に応じてヘルスチェックプローブシステムが接続する URL パスを指定できます。詳細については、HTTP、HTTPS、HTTP/2 ヘルスチェックの追加フラグをご覧ください。
- リクエストとレスポンス: TCP および SSL プロトコルでは、送信する ASCII テキスト文字列とレスポンスの想定文字列を指定できます。詳細については、SSL、TCP ヘルスチェックの追加フラグをご覧ください。
- チェック間隔: プローブを開始してから次のブローブを開始するまでの時間を指定します。
- タイムアウト: Google Cloud がプローブに対するレスポンスを待つ時間を定義します。この値は、チェック間隔の値以下にする必要があります。
- 正常しきい値: VM インスタンスが正常であると判定するために必要になるプローブ成功の連続回数を定義します。
- 異常しきい値: VM インスタンスが正常でないと判定するために必要になるプローブ失敗の連続回数を定義します。
[作成] をクリックします。

gcloud

グローバルヘルスチェックを作成するには、適切な compute health-checks create コマンドを使用します。

gcloud compute health-checks create PROTOCOL NAME \
    --global \
    --description=DESCRIPTION \
    --check-interval=CHECK_INTERVAL \
    --timeout=TIMEOUT \
    --healthy-threshold=HEALTHY_THRESHOLD \
    --unhealthy-threshold=UNHEALTHY_THRESHOLD \
    PORT_SPECIFICATION \
    ADDITIONAL_FLAGS

リージョンヘルスチェックを作成するには、適切な compute health-checks create コマンドを使用します。

gcloud compute health-checks create PROTOCOL NAME \
    --region=REGION \
    --description=DESCRIPTION \
    --check-interval=CHECK_INTERVAL \
    --timeout=TIMEOUT \
    --healthy-threshold=HEALTHY_THRESHOLD \
    --unhealthy-threshold=UNHEALTHY_THRESHOLD \
    PORT_SPECIFICATION \
    ADDITIONAL_FLAGS

以下を置き換えます。

PROTOCOL には、ヘルスチェックに使用されるプロトコルを指定します。有効なオプションは grpc、http、https、http2、ssl、tcp です。
NAME は、ヘルスチェックの名前です。特定のプロジェクト内: 各グローバルヘルスチェックには一意の名前を付ける必要があります。リージョンヘルスチェックには、特定のリージョン内で一意の名前を付ける必要があります。
REGION: リージョン外部アプリケーションロードバランサとリージョン内部アプリケーションロードバランサを除くすべてのロードバランサは、グローバルヘルスチェック（--global）を使用します。リージョン内部アプリケーションロードバランサが使用するヘルスチェックのリージョンは、バックエンドサービスのリージョンと一致している必要があります。
DESCRIPTION は省略可能な説明です。
CHECK_INTERVAL は、1 回のヘルスチェックプローブシステムの接続の開始からその次の回の開始までの時間です。単位は秒です。省略した場合、Google Cloud では 5s（5 秒）の値が使用されます。
TIMEOUT は、Google Cloud がプローブに対するレスポンスを待つ時間です。TIMEOUT の値は CHECK_INTERVAL 以下にする必要があります。単位は秒です。省略した場合、Google Cloud では 5s（5 秒）の値が使用されます。
HEALTHY_THRESHOLD と UNHEALTHY_THRESHOLD はそれぞれ、VM インスタンスが正常であるか、正常でないかを判定するために必要になるプローブの成功または失敗の連続回数を示します。いずれのしきい値も省略されている場合は、デフォルトの 2 が使用されます。
PORT_SPECIFICATION: ポート指定フラグのいずれかを使用してポート指定を定義します。
ADDITIONAL_FLAGS は、PROTOCOL に固有のポートとオプションを指定するための追加フラグです。詳しくは、HTTP、HTTPS、HTTP/2 ヘルスチェックのその他のフラグ、SSL および TCP ヘルスチェックの追加フラグ、gRPC ヘルスチェックの追加フラグをご覧ください。

Terraform

グローバルヘルスチェックを作成するには、google_compute_health_check リソースを使用します。

resource "google_compute_health_check" "health_check_tcp_with_logging" {
  provider = google-beta

  name = "health-check-tcp"

  timeout_sec        = 1
  check_interval_sec = 1

  tcp_health_check {
    port = "22"
  }

  log_config {
    enable = true
  }
}

リージョンヘルスチェックを作成するには、google_compute_region_health_check リソースを使用します。

resource "google_compute_region_health_check" "default" {
  name               = "tcp-health-check-region-west"
  timeout_sec        = 5
  check_interval_sec = 5
  tcp_health_check {
    port = "80"
  }
  region = "us-west1"
}

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

API

グローバルヘルスチェックを作成するには、healthChecks.insert を使用します。
リージョンヘルスチェックを作成するには、regionHealthChecks.insert を使用します。

ヘルスチェックを変更する

ヘルスチェックを変更して、ヘルスチェックをレガシーヘルスチェック（またはその逆）に変換することはできません。また、ヘルスチェックの名前やスコープを変更することもできません（例: グローバルからリージョンなど）。

コンソール

Google Cloud コンソールの [ヘルスチェック] ページに移動します。
[ヘルスチェック] ページに移動
ヘルスチェックをクリックすると詳細が表示されます。
ヘルスチェックを変更する必要がある場合は、[編集] をクリックして次の操作を行います。
- 必要に応じてパラメータを変更します。
- [保存] をクリックします。

gcloud

ヘルスチェックの名前とスコープを特定します。手順については、ヘルスチェックを一覧表示するをご覧ください。
ヘルスチェックの名前、プロトコル、スコープを除き、共通フラグ、ポート指定フラグ、その他の追加フラグを変更できます。既存のヘルスチェックを変更するには、適切な compute health-checks update コマンドを使用します。省略したフラグには事前構成の値が使用されます。
- グローバルヘルスチェックの変更例: 次のコマンドは、hc-http-port-80 という名前のグローバル HTTP ヘルスチェックのチェック間隔、タイムアウト、リクエストパスを変更します。
```
gcloud compute health-checks update http hc-http-port-80 \
    --global \
    --check-interval=20s \
    --timeout=15s \
    --request-path="/health"
```
- リージョンヘルスチェックの変更例: 次のコマンドは、hc-west1-tcp-ldap という名前の us-west1 でリージョン TCP ヘルスチェックのポート指定を変更します。
```
gcloud compute health-checks update tcp hc-west1-tcp-ldap \
    --region=us-west1 \
    --port=631
```

API

ヘルスチェックの名前とスコープを特定します。手順については、ヘルスチェックの一覧表示をご覧ください。
これらの API 呼び出しでは、ヘルスチェックの名前、プロトコル、スコープを除き、共通フラグ、ポート指定フラグ、その他の追加フラグを変更できます。patch API 呼び出しでは、リクエストで明示的に設定されていない事前構成が保持されます。
- グローバルヘルスチェックを変更するには、healthChecks.update または healthChecks.patch を使用します。
- リージョンヘルスチェックを変更するには、regionHealthChecks.update または regionHealthChecks.patch を使用します。

ヘルスチェックを一覧表示する

コンソール

Google Cloud コンソールの [ヘルスチェック] ページに移動します。
[ヘルスチェック] ページに移動
ヘルスチェックをクリックすると詳細が表示されます。

gcloud

ヘルスチェックを一覧表示するには、compute health-checks list コマンドを使用します。

グローバルヘルスチェックを一覧表示するには:
```
gcloud compute health-checks list \
    --global
```
リージョンヘルスチェックを一覧表示する場合は、REGION_LIST を対象の Google Cloud リージョンのカンマ区切りリストに置き換えます。
```
gcloud compute health-checks list \
    --regions=REGION_LIST
```

ヘルスチェックの名前とスコープがわかったら、compute health-checks describe コマンドを使用して現在の構成を表示します。

グローバルヘルスチェックを記述するには、NAME をその名前に置き換えます。
```
gcloud compute health-checks describe NAME \
    --global
```
リージョンヘルスチェックを記述するには、NAME をその名前に、REGION をそのリージョンに置き換えます。
```
gcloud compute health-checks describe NAME \
    --region=REGION
```

API

ヘルスチェックを一覧表示するには、次の API 呼び出しを使用します。

グローバルヘルスチェックを一覧表示する場合: healthChecks.list
リージョンヘルスチェックを一覧表示する場合: regionHealthChecks.list

ヘルスチェックの現在の構成を記述するには、次の API 呼び出しを使用します。

グローバルヘルスチェックを記述する場合: healthChecks.get
リージョンヘルスチェックを記述する場合: regionHealthChecks.get

追加フラグ

このセクションでは、ヘルスチェックを作成または変更するときに使用できるその他のフラグについて説明します。ポート指定などの一部のフラグは、gcloud または API を使用して設定する必要があります。

ポート指定フラグ

Google Cloud CLI または API を使用してヘルスチェックを作成する場合、ヘルスチェックのポートを指定する方法が 2 つあります。次の表に、有効なロードバランサとバックエンドの組み合わせに対するポート指定オプションを示します。インスタンスグループという用語は、非マネージドインスタンスグループ、ゾーンマネージドインスタンスグループ、リージョンマネージドインスタンスグループを指します。

各ヘルスチェックで使用できるポート指定のタイプは 1 種類のみです。

プロダクト	バックエンドタイプ	ポート指定オプション
外部パススルーネットワークロードバランサ	インスタンスグループ	• `--port`: TCP ポートを `1` から `65535` の番号で指定します。外部パススルーネットワークロードバランサに関連付けられたヘルスチェックでは `--use-serving-port` フラグは無視されます。これは、外部パススルーネットワークロードバランサのバックエンドサービスにはポート指定がないためです。
内部パススルーネットワークロードバランサ	インスタンスグループ	• `--port`: TCP ポートを `1` から `65535` の番号で指定します。内部パススルーネットワークロードバランサに関連付けられたヘルスチェックでは `--use-serving-port` フラグは無視されます。これは、内部パススルーネットワークロードバランサのバックエンドサービスにはポート指定がないためです。
グローバル外部アプリケーションロードバランサリージョン外部アプリケーションロードバランサクロスリージョン内部アプリケーションロードバランサリージョン内部アプリケーションロードバランサグローバル外部プロキシネットワークロードバランサ従来のプロキシネットワークロードバランサリージョン外部プロキシネットワークロードバランサリージョン内部プロキシネットワークロードバランサクロスリージョン内部プロキシネットワークロードバランサ Cloud Service Mesh	ゾーン NEG	• `--port`: TCP ポートを `1` から `65535` の番号で指定します。 • `--use-serving-port`: ネットワークエンドポイントグループ内の各エンドポイントのポートを使用します。
	インスタンスグループ	• `--port`: TCP ポートを `1` から `65535` の番号で指定します。 • `--use-serving-port`: バックエンドサービスがサブスクライブするポートと同じインスタンスグループを使用します。

ポート指定を省略すると、Google Cloud は次のデフォルトを使用します。

ヘルスチェックのプロトコルが TCP または HTTP の場合は、--port=80 を使用します。
ヘルスチェックのプロトコルが SSL、HTTPS、HTTP2 の場合は、--port=443 を使用します。
ヘルスチェックのプロトコルが GRPC の場合、暗黙のデフォルトはありません。ポート指定を含める必要があります。

HTTP、HTTPS、HTTP/2 ヘルスチェックの追加フラグ

HTTP、HTTPS、HTTP/2 のヘルスチェックには、共通のフラグとポートの指定に加えて、次のオプションのフラグも使用できます。次の例では、間隔、タイムアウト値、正常性しきい値基準にデフォルト値を使用し、ポート 80 を使用する hc-http-port-80 という名前の HTTP ヘルスチェックを作成します。

gcloud compute health-checks create HTTP_PROTOCOL hc-http-port-80 \
    COMMON_FLAGS \
    PORT_SPECIFICATION \
    --host=HOST \
    --proxy-header=PROXY_HEADER \
    --request-path=REQUEST_PATH \
    --response=RESPONSE

HTTP_PROTOCOL: http（TLS なしの HTTP/1.1）、https（TLS を使用する HTTP/1.1）、http2（TLS を使用する HTTP/2）のいずれかです。
COMMON_FLAGS: 共通フラグを定義します。作成手順をご覧ください。
PORT_SPECIFICATION: ポート指定フラグのいずれかを使用してポート指定を定義します。
HOST を使用すると、Host HTTP ヘッダーを指定できます。省略した場合は、ロードバランサの転送ルールの IP アドレスが使用されます。
PROXY_HEADER は、NONE か PROXY_V1 のいずれかにする必要があります。省略した場合は、Google Cloud では NONE が使用されます。PROXY_V1 の値には、ヘッダー PROXY UNKNOWN\r\n が追加されます。
REQUEST_PATH には、ヘルスチェックリクエストの送信時に Google Cloud が使用する URL パスを指定します。省略すると、ヘルスチェックリクエストは / に送信されます。
RESPONSE では、想定される任意のレスポンスを指定します。レスポンスの文字列は次のルールに従って表します。
- レスポンス文字列は、ASCII 文字、数字、スペースで構成する必要があります。
- レスポンス文字列は最長 1,024 文字です。
- ワイルドカードマッチングはサポートされていません。
- コンテンツベースのチェックでは、たとえば、HAProxy における ! 演算子などの反転法はサポートされません。

Google Cloud が受信したレスポンス本文の最初の 1,024 バイトのうちのどこかで想定されるレスポンス文字列を検出し、さらに HTTP ステータスが 200（OK）の場合、プローブは正常終了と見なされます。

ヘルスチェックプローブの正常完了条件は、--request-path フラグと --response フラグによって変わります。

SSL、TCP ヘルスチェックの追加フラグ

SSL と TCP のヘルスチェックには、共通のフラグとポートの指定に加えて、次のオプションのフラグを使用できます。次の例では、間隔、タイムアウト値、正常性しきい値基準にデフォルト値を使用し、ポート 3268 を使用する hc-tcp-3268 という名前の TCP ヘルスチェックを作成します。

gcloud compute health-checks create tcp hc-tcp-3268 \
    COMMON_FLAGS \
    PORT_SPECIFICATION \
    --proxy-header=PROXY_HEADER \
    --request=REQUEST_STRING \
    --response=RESPONSE_STRING

プロトコルには、tcp（この例）または ssl を使用できます。
COMMON_FLAGS: 共通フラグを定義します。作成手順をご覧ください。
PORT_SPECIFICATION: ポート指定フラグのいずれかを使用してポート指定を定義します。
PROXY_HEADER は、NONE か PROXY_V1 のいずれかにする必要があります。省略した場合は、Google Cloud では NONE が使用されます。PROXY_V1 の値には、ヘッダー PROXY UNKNOWN\r\n が追加されます。
REQUEST_STRING: TCP または SSL セッションが確立されると送信される最長 1024 文字の ASCII 文字を指定できます。
RESPONSE_STRING: レスポンスとして想定される最長 1,024 文字の ASCII 文字列を指定できます。

ヘルスチェックプローブの正常完了条件は、--request フラグと --response フラグによって変わります。--response フラグを単独、あるいは --request フラグとともに使用する場合は、返されるレスポンスがレスポンスの想定文字列と完全に一致する必要があります。

gRPC ヘルスチェックの追加フラグ

gRPC ヘルスチェックプロトコルで説明されている手順に沿って、バックエンド gRPC サーバーは gRPC ヘルスチェックサービスを実装する必要があります。Google Cloud は、バックエンドのヘルスサービスの Check メソッドを呼び出すことで、HealthCheckRequest メッセージをバックエンドに送信します。gRPC サービス名が未指定の場合、リクエストのサービスパラメータは空の文字列に設定されます。

gRPC ヘルスチェックでは、gRPC サービスのステータスを確認できます。最長 1,024 文字の ASCII 文字を含めることができます。これは、バックエンド VM または NEG で実行される特定の gRPC サービスの名前です。gRPC ヘルスチェックに次のオプションのフラグを使用して、ステータスを確認します。

--grpc-service-name=GRPC_SERVICE_NAME

たとえば、バックエンドサーバーが、次のサービスとステータスをバックエンドの gRPC ヘルスサービスに登録するとします。

配信ステータスが SERVING の MyPackage.ServiceA
配信ステータスが NOT_SERVING の MyPackage.ServiceB
配信ステータスが NOT_SERVING の空のサービス名

次のように MyPackage.ServiceA のヘルスチェックを作成する場合、サービスのステータスが SERVING のため、ヘルスチェックプローブは HEALTHY を返します。

gcloud beta compute health-checks create grpc MyGrpcHealthCheckServiceA \
    --grpc-service-name=MyPackage.ServiceA

MyPackage.ServiceB のヘルスチェックを作成する場合、サービスのステータスが NOT_SERVING のため、ヘルスチェックプローブは UNHEALTHY を返します。

gRPC Health サービスに登録されていない MyPackage.ServiceC のヘルスチェックを作成すると、ヘルスチェックプローブは gRPC ステータス NOT_FOUND を返します。これは、UNHEALTHY に相当します。

空のサービス名のヘルスチェックを作成すると、空のサービス名が NOT_SERVING で登録されるため、ヘルスチェックプローブは UNHEALTHY のステータスを返します。

レガシーヘルスチェック

このセクションでは、レガシー HTTP および HTTPS ヘルスチェックの作成、変更、一覧表示を行う方法について説明します。レガシーヘルスチェックをヘルスチェックに変換することはできません。また、ヘルスチェックをレガシーヘルスチェックに変換することもできません。

レガシーヘルスチェックをサポートするロードバランサの種類については、ロードバランサガイドをご覧ください。

レガシーヘルスチェックを作成する

コンソール

Google Cloud コンソールのヘルスチェックページには、ヘルスチェックとレガシーヘルスチェックの両方が表示され、編集できますが、Google Cloud コンソールのヘルスチェックページから作成することはできません。

Google Cloud コンソールでレガシーヘルスチェックを作成できるのは、ターゲットプールベースの外部パススルーネットワークロードバランサを作成する場合のみです。レガシーヘルスチェックのみを作成するには、このセクションの gcloud または API の手順を使用します。

gcloud

レガシーヘルスチェックを作成するには、compute http-health-checks create コマンドを使用します。

gcloud compute LEGACY_CHECK_TYPE create NAME \
    --description=DESCRIPTION \
    --check-interval=CHECK_INTERVAL \
    --timeout=TIMEOUT \
    --healthy-threshold=HEALTHY_THRESHOLD \
    --unhealthy-threshold=UNHEALTHY_THRESHOLD \
    --host=HOST \
    --port=PORT \
    --request-path=REQUEST_PATH

以下を置き換えます。

レガシー HTTP ヘルスチェックの場合、LEGACY_CHECK_TYPE は http-health-checks です。レガシー HTTPS ヘルスチェックの場合は https-health-checks です。ターゲットプールベースの外部パススルーネットワークロードバランサのレガシーヘルスチェックを作成する場合は、http-health-checks を使用する必要があります。
NAME は、レガシーヘルスチェックの名前です。各レガシーヘルスチェックにはプロジェクト内で一意の名前を付ける必要があります。
DESCRIPTION は省略可能な説明です。
CHECK_INTERVAL は、1 回のプローブの開始から次の回のブローブ開始までの時間です。単位は秒です。省略した場合、Google Cloud では 5s（5 秒）の値が使用されます。
TIMEOUT は、Google Cloud でプローブに対するレスポンスを待つ時間です。TIMEOUT の値は CHECK_INTERVAL 以下にする必要があります。単位は秒です。省略した場合、Google Cloud では 5s（5 秒）の値が使用されます。
HEALTHY_THRESHOLD と UNHEALTHY_THRESHOLD はそれぞれ、VM インスタンスが正常であるか、正常でないかを判定するために必要になるプローブの成功または失敗の連続回数を示します。いずれのしきい値も省略されている場合は、デフォルトの 2 が使用されます。
HOST を使用すると、ホストの HTTP ヘッダーを指定できます。省略した場合は、ロードバランサの転送ルールの IP アドレスが使用されます。
PORT を使用すると、ポート番号を指定できます。省略した場合は、Google Cloud では 80 が使用されます。
REQUEST_PATH には、ヘルスチェックリクエストの送信時に Google Cloud が使用する URL パスを指定します。省略すると、ヘルスチェックリクエストは / に送信されます。

API

レガシー HTTP ヘルスチェックを作成するには、httpHealthChecks.insert API 呼び出しを使用します。
レガシー HTTPS ヘルスチェックを作成するには、httpsHealthChecks.insert を使用します。

Terraform

レガシー HTTP ヘルスチェックリソースを作成するには、google_compute_http_health_check リソースを使用します。
レガシー HTTPS ヘルスチェックリソースを作成するには、google_compute_https_health_check リソースを使用します。

レガシーヘルスチェックを変更する

コンソール

Google Cloud コンソールの [ヘルスチェック] ページに移動します。
[ヘルスチェック] ページに移動
ヘルスチェックをクリックすると詳細が表示されます。
[編集]（）をクリックして変更を行い、[保存] をクリックします。

gcloud

レガシー HTTP ヘルスチェックを変更するには、compute http-health-checks update コマンドを使用します。NAME はその名前で置き換えます。gcloud を使用してレガシーヘルスチェックを変更する場合、省略したフラグには事前構成された値が使用されます。OTHER_OPTIONS は、レガシーヘルスチェックの作成で説明されているオプションです。
```
gcloud compute http-health-checks update NAME \
  OTHER_OPTIONS
```
レガシー HTTPS ヘルスチェックを変更するには、compute https-health-checks update コマンドを使用します。NAME はその名前で置き換えます。gcloud を使用してレガシーヘルスチェックを変更する場合、省略したフラグには事前構成された値が使用されます。OTHER_OPTIONS は、レガシーヘルスチェックの作成で説明されているオプションです。
```
gcloud compute https-health-checks update NAME \
  OTHER_OPTIONS
```

API

レガシーヘルスチェックの名前とタイプを除き、その作成に使用するフラグのいずれも変更可能です。patch API 呼び出しでは、パッチリクエストで明示的に設定されていない事前構成済みの設定が保持されます。

レガシー HTTP ヘルスチェックを変更するには、httpHealthChecks.update または httpHealthChecks.patch を使用します。
レガシー HTTPS ヘルスチェックを変更するには、httpsHealthChecks.update または httpsHealthChecks.patch を使用します。

レガシーヘルスチェックを一覧表示する

コンソール

Google Cloud コンソールの [ヘルスチェック] ページに移動します。
[ヘルスチェック] ページに移動
レガシーヘルスチェックをクリックすると詳細が表示されます。

gcloud

レガシー HTTP ヘルスチェックを一覧表示するには、compute http-health-checks list コマンドを使用します。
```
gcloud compute http-health-checks list
```
レガシー HTTPS ヘルスチェックを一覧表示するには、compute https-health-checks list コマンドを使用します。
```
gcloud compute https-health-checks list
```
レガシー HTTP ヘルスチェックを記述するには、compute http-health-checks describe コマンドを使用して、NAME をその名前に置き換えます。
```
gcloud compute http-health-checks describe NAME
```
レガシー HTTPS ヘルスチェックを記述するには、compute https-health-checks describe コマンドを使用して、NAME をその名前に置き換えます。
```
gcloud compute https-health-checks describe NAME
```

API

レガシーヘルスチェックを一覧表示するには:
- httpHealthChecks.list を使用して、レガシー HTTP ヘルスチェックを一覧表示します。
- httpsHealthChecks.list を使用して、レガシー HTTPS ヘルスチェックを一覧表示します。
レガシーヘルスチェックを記述するには:
- httpHealthChecks.get を使用して、レガシー HTTP ヘルスチェックを記述します。
- httpsHealthChecks.get を使用して、レガシー HTTPS ヘルスチェックを記述します。

必要なファイアウォールルールを作成する

ヘルスチェックプローバーの IP 範囲からのトラフィックを許可するには、ロードバランシング対象のすべての VM に適用される上り（内向き）ファイアウォールルールを作成する必要があります。次の例では、特定のターゲットタグで識別される VM インスタンスに適用されるファイアウォールルールを作成します。

この例では、Google Cloud ヘルスチェックシステムから VM インスタンスへのすべての TCP トラフィックを許可します。この TCP トラフィックには SSL、HTTP、HTTPS、HTTP/2 のトラフィックが含まれます。必要に応じて、ポートを TCP プロトコルとともに指定することもできます。ただし、ポートを指定すると、ファイアウォールルールが特定のヘルスチェックに限定される場合があります。プロトコルとポートに tcp:80 を使用すると、ポート 80 で TCP トラフィックが許可されます。このため Google Cloud は VM に HTTP を使用してポート 80 で接続できますが、HTTPS を使用したポート 443 での接続はできないことになります。

コンソール

Google Cloud コンソールで [ファイアウォールポリシー] ページに移動します。
[ファイアウォールポリシー] に移動
[ファイアウォールルールを作成] をクリックします。
ファイアウォールルールの作成ページで、次の情報を入力します。
- 名前: ルールの名前を指定します。この例では、fw-allow-health-checks を使用します。
- ネットワーク: VPC ネットワークを選択します。
- 優先度: 優先度の数値を入力します。数字が小さいほど優先度が高くなります。このファイアウォールルールには、上り（内向き）トラフィックを拒否する可能性がある他のルールよりも高い優先度を設定してください。
- トラフィックの方向: [上り] を選択します。
- 一致したときのアクション: [許可] を選択します。
- ターゲット: [指定されたターゲットタグ] を選択し、[ターゲットタグ] フィールドにタグを入力します。この例では、allow-health-checks を使用します。
- ソースフィルタ: [IP 範囲] を選択します。
- ソース IP の範囲: ロードバランサの種類、トラフィックタイプ、ヘルスチェックのタイプに応じて、ソース IP の範囲を入力します。プローブの IP 範囲とファイアウォールルールをご覧ください。
- 許可対象プロトコルとポート: tcp と、ヘルスチェックで構成されているポートを使用します。TCP は、すべてのヘルスチェックプロトコルの基礎となるプロトコルです。
- [作成] をクリックします。
ロードバランスされる各インスタンスで、ネットワークタグを追加して、新しい上り（内向き）ファイアウォールルールが適用されるようにします。この例では、ネットワークタグに allow-health-checks を使用します。

gcloud

次の gcloud コマンドを使用して、Google Cloud ヘルスチェックシステムから VPC ネットワーク内のインスタンスへの受信 TCP 接続を allow-health-checks タグで許可するファイアウォールルールを fw-allow-health-checks という名前で作成します。ロードバランサのタイプに基づいて、バックエンドへの IPv6 トラフィックに対して、異なるプローブ IP 範囲とファイアウォールルールのセットがサポートされます。たとえば、2600:2d00:1:b029::/64 はグローバル外部アプリケーションロードバランサとグローバル外部プロキシネットワークロードバランサに使用されます。

NETWORK_NAME は VPC ネットワークの名前に置き換え、PORT はロードバランサが使用するポートに置き換えます。
```
gcloud compute firewall-rules create fw-allow-health-checks \
    --network=NETWORK_NAME \
    --action=ALLOW \
    --direction=INGRESS \
    --source-ranges=SOURCE_IP_RANGE \
    --target-tags=allow-health-checks \
    --rules=tcp:PORT
```
SOURCE_IP_RANGE の値は、ロードバランサの種類、トラフィックタイプ、ヘルスチェックのタイプによって異なります。プローブの IP 範囲とファイアウォールルールをご覧ください。
ロードバランスされる各インスタンスで、ネットワークタグを追加して、新しい上り（内向き）ファイアウォールルールが適用されるようにします。この例では、ネットワークタグに allow-health-checks を使用します。

詳細については、gcloud ファイアウォールルールのドキュメントと API ドキュメントをご覧ください。

ヘルスチェックをロードバランサに関連付ける

まだ確認していない場合は、ヘルスチェックの概要: ヘルスチェックを選択するを確認します。

ヘルスチェックを新しいロードバランサに関連付けるには、それぞれのロードバランサの設定ガイドをご覧ください。このセクションでは、既存のロードバランサのバックエンドサービスにヘルスチェックを関連付ける方法について説明します。

このセクションは、すでに以下の処理が行われていることを前提としています。

ロードバランサが作成されていること。
ヘルスチェックを作成している。
必要なファイアウォールルールを作成している。

コンソール

ヘルスチェックを既存のロードバランサに関連付けるには、次のようにします。

Google Cloud コンソールの [ロードバランシング] ページに移動します。
[ロードバランシング] ページに移動
ロードバランサをクリックして、その詳細を表示します。
編集アイコンをクリックしてから、[バックエンドの構成] をクリックします。
[ヘルスチェック] メニューからいずれかのヘルスチェックを選択します。
[更新] をクリックします。

gcloud

ヘルスチェックを既存のバックエンドサービスに関連付ける手順は、次のとおりです。

バックエンドサービスの名前とスコープを特定します。外部パススルーネットワークロードバランサ、内部パススルーネットワークロードバランサ、リージョン内部プロキシネットワークロードバランサ、外部プロキシネットワークロードバランサには、ロードバランサごとに 1 つのバックエンドサービスしかありません。外部アプリケーションロードバランサと内部アプリケーションロードバランサには、単一の URL マップに関連付けられた 1 つ以上のバックエンドサービスがあります。
- 内部パススルーネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。REGION_LIST は、クエリ対象の Google Cloud リージョンのカンマ区切りリストに置き換えます。
```
gcloud compute backend-services list \
    --filter="region:( REGION1 REGION2 ... ) AND loadBalancingScheme=INTERNAL"
```
- 外部パススルーネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。各 REGION は、クエリ対象の Google Cloud リージョンに置き換えます。
```
gcloud compute backend-services list \
    --filter="region:( REGION1 REGION2 ... ) AND loadBalancingScheme=EXTERNAL"
```
- グローバル外部プロキシネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。
```
gcloud compute backend-services list \
    --global \
    --filter="loadBalancingScheme=EXTERNAL_MANAGED" \
    --filter="protocol=(SSL,TCP)"
```
- 従来のプロキシネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。
```
gcloud compute backend-services list \
    --global \
    --filter="loadBalancingScheme=EXTERNAL" \
    --filter="protocol=(SSL,TCP)"
```
- リージョン外部プロキシネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。
```
gcloud compute backend-services list \
    --region=REGION \
    --filter="loadBalancingScheme=EXTERNAL_MANAGED" \
    --filter="protocol=(SSL,TCP)"
```
- リージョン内部プロキシネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。REGION_LIST は、クエリ対象の Google Cloud リージョンのカンマ区切りリストに置き換えます。
```
gcloud beta compute backend-services list \
    --filter="region:( REGION1 REGION2 ... ) AND loadBalancingScheme=INTERNAL_MANAGED"
```
- SSL を使用して外部プロキシネットワークロードバランサのバックエンドサービスを一覧表示するには、次のコマンドを実行します。これらのロードバランサのバックエンドサービスは、ネットワークサービスティアに関係なく常にグローバルです。
```
gcloud compute backend-services list \
    --global \
    --filter="loadBalancingScheme=EXTERNAL" \
    --filter="protocol=(SSL,TCP)"
```
- 外部アプリケーションロードバランサのバックエンドサービスを特定するには、まず URL マップを特定してから、そのマップの説明を取得します。外部アプリケーションロードバランサまたはクロスリージョン内部アプリケーションロードバランサの URL マップとバックエンドサービスは、ネットワークサービスティアに関係なく常にグローバルです。URL_MAP_NAME は、URL マップの名前に置き換えます。ロードバランサによって使用されるバックエンドサービスがレスポンスに含まれます。
```
gcloud compute url-maps list \
    --global
```
```
gcloud compute url-maps describe URL_MAP_NAME \
    --global
```
- リージョン外部アプリケーションロードバランサまたはリージョン内部アプリケーションロードバランサのバックエンドサービスを特定するには、まず URL マップを特定してから、そのマップの説明を取得します。これらのロードバランサの URL マップとバックエンドサービスはどちらもリージョンになります。REGION_LIST は、クエリ対象の Google Cloud リージョンのカンマ区切りリストに置き換えます。URL_MAP_NAME は URL マップの名前に置き換え、REGION はそのリージョンに置き換えます。ロードバランサによって使用されるバックエンドサービスがレスポンスに含まれます。
```
gcloud compute url-maps list \
    --regions=REGION_LIST
```
```
gcloud compute url-maps describe URL_MAP_NAME \
    --region=REGION
```
ヘルスチェックを特定します。ヘルスチェックの一覧表示をご覧ください。
compute backend-services update コマンドを使用して、ヘルスチェックをバックエンドサービスに関連付けます。各バックエンドサービスは 1 つのヘルスチェックを参照する必要があります。次のコマンドで、BACKEND_SERVICE_NAME をバックエンドサービスの名前に、HEALTH_CHECK_NAME をヘルスチェックの名前に、必要に応じて REGION をバックエンドサービス、ヘルスチェック、または両方の Google Cloud リージョンに置き換えます。
- 内部パススルーネットワークロードバランサのヘルスチェックを変更する場合: 内部パススルーネットワークロードバランサのバックエンドサービスはリージョンです。グローバルまたはリージョンのヘルスチェックを参照できます。次の例は、リージョンのヘルスチェックのリファレンスを示しています。内部パススルーネットワークロードバランサでグローバルヘルスチェックを使用している場合は、--health-checks-region ではなく --global-health-checks を使用します。
```
gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --region=REGION \
    --health-checks=HEALTH_CHECK_NAME \
    --health-checks-region=REGION
```
- バックエンドサービスベースの外部パススルーネットワークロードバランサのヘルスチェックを変更する場合: 外部パススルーネットワークロードバランサのバックエンドサービスはリージョンです。リージョンヘルスチェックを参照できます。
```
gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --region=REGION \
    --health-checks=HEALTH_CHECK_NAME \
    --health-checks-region=REGION
```
- グローバル外部プロキシネットワークロードバランサ、従来のプロキシネットワークロードバランサ、グローバル外部アプリケーションロードバランサ、従来のアプリケーションロードバランサ、またはクロスリージョン内部アプリケーションロードバランサのヘルスチェックを変更する場合: バックエンドサービスとヘルスチェックは、これらのロードバランサに対してどちらもグローバルです。アプリケーションロードバランサが複数のバックエンドサービスを参照している場合、複数のヘルスチェックが参照される可能性があります。
```
gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --global \
    --health-checks HEALTH_CHECK_NAME \
    --global-health-checks
```
- リージョン外部アプリケーションロードバランサ、リージョン外部プロキシネットワークロードバランサ、リージョン内部プロキシネットワークロードバランサ、またはリージョン内部アプリケーションロードバランサのいずれかのヘルスチェックを変更する場合: バックエンドサービスとヘルスチェックはどちらもリージョンです。一部のロードバランサが複数のバックエンドサービスを参照できる場合、複数のヘルスチェックが参照される可能性があります。
```
gcloud compute backend-services update BACKEND_SERVICE_NAME \
    --region=REGION \
    --health-checks=HEALTH_CHECK_NAME \
    --health-checks-region=REGION
```

API

バックエンドサービスを一覧表示するには、backendServices.list API 呼び出しを使用します。
ヘルスチェックを表示します。
ヘルスチェックをバックエンドサービスに関連付けるには、次のいずれかの API 呼び出しを使用します。
- backendServices.update
- backendServices.patch

レガシーヘルスチェックをターゲットプールベースの外部パススルーネットワークロードバランサに関連付ける

レガシーヘルスチェックを新しい外部パススルーネットワークロードバランサに関連付けるには、ターゲットプールを使用した外部パススルーネットワークロードバランサを設定するをご覧ください。このセクションでは、レガシーヘルスチェックをターゲットプールベースの外部パススルーネットワークロードバランサに関連付ける方法について説明します。

このセクションは、すでに以下の処理が行われていることを前提としています。

ターゲットプールベースの外部パススルーネットワークロードバランサを作成している。
レガシーヘルスチェックを作成している。
必要なファイアウォールルールを作成している。

コンソール

ヘルスチェックを既存のターゲットプールベースの外部パススルーネットワークロードバランサに関連付けるには、次のようにします。

Google Cloud コンソールの [ロードバランシング] ページに移動します。
[ロードバランシング] ページに移動
ロードバランサをクリックして、その詳細を表示します。
編集アイコンをクリックしてから、[バックエンドの構成] をクリックします。
[ヘルスチェック] メニューからいずれかのレガシーヘルスチェックを選択します（有効なレガシーヘルスチェックのみが表示されています）。
[更新] をクリックします。

gcloud

ヘルスチェックを既存のターゲットプールベースの外部パススルーネットワークロードバランサに関連付けるには、次のようにします。

ターゲットプールを特定します。外部パススルーネットワークロードバランサには、少なくとも 1 つのターゲットプールがあり、セカンダリバックアッププールがある場合があります。
```
gcloud compute target-pools list
```
HTTP プロトコルを使用して、レガシーヘルスチェックを特定します。必要に応じて、レガシーヘルスチェックを表示します。
レガシーヘルスチェックとターゲットプールを関連付けます。次のコマンドの TARGET_POOL_NAME をターゲットプールの名前に、REGION をリージョンに、LEGACY_CHECK_NAME をレガシーヘルスチェックの名前にそれぞれ置き換えます。レガシーヘルスチェックでは、HTTP プロトコルを使用する必要があります。
- ターゲットプールからレガシー HTTP ヘルスチェックを削除するには、次のコマンドを実行します。
```
gcloud compute target-pools remove-health-checks TARGET_POOL_NAME \
    --region=REGION \
    --http-health-check LEGACY_CHECK_NAME
```
- レガシー HTTP ヘルスチェックをターゲットプールに追加するには、次のコマンドを実行します。
```
gcloud compute target-pools add-health-checks TARGET_POOL_NAME \
    --region=REGION \
    --http-health-check LEGACY_CHECK_NAME
```

API

ターゲットプールを一覧表示するには、targetPools.list API 呼び出しを使用します。
レガシーヘルスチェックを表示して、レガシー HTTP ヘルスチェックを確認します。
レガシー HTTP ヘルスチェックをターゲットプールに関連付けるには、targetPools.addHealthCheck API 呼び出しを使用します。

ヘルスチェックのステータスを確認する

ヘルスチェックをバックエンドサービスまたはターゲットプールに関連付けると、ロードバランサのバックエンドの最新のヘルスチェック状態を取得できます。

コンソール

負荷分散の概要ページに移動します。
[負荷分散] ページに移動
ロードバランサの名前をクリックします。
[バックエンド] で [正常] 列を調べます。ヘルスステータスは、バックエンドインスタンスグループまたはネットワークエンドポイントグループごとに報告されます。

gcloud

ターゲットプールベースの外部パススルーネットワークロードバランサを除くロードバランサの場合は、バックエンドサービスの名前とスコープ（グローバルまたはリージョン）を特定します。ロードバランサとスコープの完全なリストについては、バックエンドサービスをご覧ください。

compute backend-services get-health コマンドを使用します。必要に応じて、NAME をバックエンドサービスの名前に、REGION をそのリージョンに置き換えます。
- グローバルバックエンドサービスの最新のヘルスステータスを取得するには:
```
gcloud compute backend-services get-health GLOBAL_BACKEND_SERVICE_NAME \
    --global
```
- リージョンバックエンドサービスの最新のヘルスステータスを取得するには:
```
gcloud compute backend-services get-health REGIONAL_BACKEND_SERVICE_NAME \
    --region=REGION
```
ターゲットプールベースの外部パススルーネットワークロードバランサの場合は、ロードバランサのターゲットプールの名前とリージョンを特定したうえで、compute target-pools get-health コマンドを使用し、NAME をターゲットプールの名前に、REGION をそのリージョンに置き換えます。
```
gcloud compute target-pools get-health TARGET_POOL_NAME \
    --region=REGION
```

API

ターゲットプールベースの外部パススルーネットワークロードバランサを除くロードバランサの場合は、バックエンドサービスの名前とスコープ（グローバルまたはリージョン）を特定します。ロードバランサとスコープの完全なリストについては、バックエンドサービスをご覧ください。
- グローバルバックエンドサービスの最新のヘルスステータスを取得するには、backendServices.getHealth を使用します。
- リージョンバックエンドサービスの最新のヘルスステータスを取得するには、regionBackendServices.getHealth を使用します。
ターゲットプールベースの外部パススルーネットワークロードバランサの場合は、targetPools.getHealth を使用します。

ヘルスチェックを使用する

ヘルスチェックを作成する

コンソール

gcloud

Terraform

API

ヘルスチェックを変更する

コンソール

gcloud

API

ヘルスチェックを一覧表示する

コンソール

gcloud

API

追加フラグ

ポート指定フラグ

HTTP、HTTPS、HTTP/2 ヘルスチェックの追加フラグ

SSL、TCP ヘルスチェックの追加フラグ

gRPC ヘルスチェックの追加フラグ

レガシー ヘルスチェック

レガシー ヘルスチェックを作成する

コンソール

gcloud

API

Terraform

レガシー ヘルスチェックを変更する

コンソール

gcloud

API

レガシー ヘルスチェックを一覧表示する

コンソール

gcloud

API

必要なファイアウォール ルールを作成する

コンソール

gcloud

ヘルスチェックをロードバランサに関連付ける

コンソール

gcloud

API

レガシー ヘルスチェックをターゲット プール ベースの外部パススルー ネットワーク ロードバランサに関連付ける

コンソール

gcloud

API

ヘルスチェックのステータスを確認する

コンソール

gcloud

API

レガシーヘルスチェック

レガシーヘルスチェックを作成する

レガシーヘルスチェックを変更する

レガシーヘルスチェックを一覧表示する

必要なファイアウォールルールを作成する

レガシーヘルスチェックをターゲットプールベースの外部パススルーネットワークロードバランサに関連付ける