複合ヘルス リソースの表示、更新、削除
このページでは、Composite Health リソースを作成した後に管理する方法について説明します。ヘルス集約ポリシー、ヘルスソース、複合ヘルスチェックの一覧表示、説明、更新、削除を行えます。
ヘルス集計ポリシーを管理する
このセクションでは、ヘルス集計ポリシーの管理方法について説明します。
ヘルス集計ポリシーを一覧表示する
構成したヘルス集計ポリシーを一覧表示できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[ヘルス集計ポリシー] をクリックします。
gcloud
リージョン内のすべてのヘルス集計ポリシーを一覧表示するには、gcloud compute health-aggregation-policies list コマンドを使用します。
gcloud compute health-aggregation-policies list \
--regions=REGION
REGION は、ヘルス集約ポリシーのリージョンに置き換えます。
API
リージョン内のすべてのヘルス集計ポリシーを一覧表示するには、regionHealthAggregationPolicies.list メソッドにリクエストを送信します。
HTTP メソッドと URL:
GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthAggregationPolicies
次のように置き換えます。
PROJECT_ID: ヘルス集計ポリシーのプロジェクト ID。REGION: ヘルス集約ポリシーのリージョン。
ヘルス集計ポリシーの説明を取得する
ヘルス集計ポリシーの説明を取得して、その詳細を表示できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[ヘルス集計ポリシー] をクリックします。
説明するヘルス集計ポリシーの名前をクリックします。
gcloud
gcloud compute health-aggregation-policies describe コマンドを使用します。
gcloud compute health-aggregation-policies describe POLICY \
--region=REGION
次のように置き換えます。
POLICY: ヘルス集約ポリシーの名前REGION: ヘルス集約ポリシーのリージョン
API
リクエストを regionHealthAggregationPolicies.get メソッドに送信します。
HTTP メソッドと URL:
GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthAggregationPolicies/POLICY
次のように置き換えます。
PROJECT_ID: ヘルス集計ポリシーのプロジェクト ID。REGION: ヘルス集約ポリシーのリージョン。POLICY: ヘルス集約ポリシーの名前。
ヘルス集計ポリシーを更新する
ヘルス集計ポリシーの説明、正常な割合のしきい値、正常な最小しきい値は更新できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[ヘルス集計ポリシー] をクリックします。
更新するヘルス集計ポリシーの名前をクリックします。
[ 編集] をクリックします。
変更するフィールドを更新します。
[保存] をクリックします。
gcloud
gcloud compute health-aggregation-policies update コマンドを使用します。更新しないプロパティのフラグは省略します。
gcloud compute health-aggregation-policies update POLICY \
--region=REGION \
--description="DESCRIPTION" \
--healthy-percent-threshold=PERCENT_HEALTHY \
--min-healthy-threshold=MINIMUM_HEALTHY
次のように置き換えます。
POLICY: 更新するヘルス集約ポリシーの名前REGION: ヘルス集約ポリシーのリージョンDESCRIPTION: ポリシーの更新された説明PERCENT_HEALTHY: ヘルスソースが正常と見なされるために正常である必要があるバックエンド サービス内のエンドポイントの最小割合の更新値(例:75)MINIMUM_HEALTHY: ヘルスソースが正常と見なされるために正常である必要があるバックエンド サービス内のエンドポイントの最小数(例:2)
API
ヘルス集計ポリシーの説明を取得し、次のステップで使用する
fingerprintキーの値をメモします。リクエストを
regionHealthAggregationPolicies.patchメソッドに送信します。更新しないプロパティのフィールドは省略します。HTTP メソッドと URL:
PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthAggregationPolicies/POLICY
リクエストの本文(JSON):
{ "description": "DESCRIPTION", "healthyPercentThreshold": PERCENT_HEALTHY, "minHealthyThreshold": MINIMUM_HEALTHY, "fingerprint": "FINGERPRINT" }次のように置き換えます。
PROJECT_ID: ヘルス集計ポリシーのプロジェクト ID。REGION: ヘルス集約ポリシーのリージョン。POLICY: 更新するヘルス集約ポリシーの名前。DESCRIPTION: ポリシーの更新された説明。PERCENT_HEALTHY: ヘルスソースが正常と見なされるために正常である必要があるバックエンド サービス内のエンドポイントの最小割合の更新値(例:75)。MINIMUM_HEALTHY: ヘルスソースが正常と見なされるために正常である必要があるバックエンド サービス内のエンドポイントの最小数(例:2)。FINGERPRINT: 前の手順で確認したfingerprintキーの最新の値。
ヘルス集計ポリシーを削除する
ヘルス集約ポリシーは、既存のヘルスソースに関連付けられていない場合に削除できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[ヘルス集計ポリシー] をクリックします。
削除するヘルス集約ポリシーの横にあるチェックボックスをオンにします。
[削除] をクリックします。
[削除] をクリックして確定します。
gcloud
gcloud compute health-aggregation-policies delete コマンドを使用します。
gcloud compute health-aggregation-policies delete POLICY \
--region=REGION
次のように置き換えます。
POLICY: 削除するヘルス集約ポリシーの名前REGION: ヘルス集約ポリシーのリージョン
API
リクエストを regionHealthAggregationPolicies.delete メソッドに送信します。
HTTP メソッドと URL:
DELETE https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthAggregationPolicies/POLICY
次のように置き換えます。
PROJECT_ID: ヘルス集計ポリシーのプロジェクト ID。REGION: ヘルス集約ポリシーのリージョン。POLICY: 削除するヘルス集約ポリシーの名前。
ヘルスソースを管理する
以降のセクションでは、健康状態のソースを管理する方法について説明します。
ヘルスソースを一覧表示する
構成したヘルスソースを一覧表示できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[健康状態のソース] をクリックします。
gcloud
リージョン内のすべてのヘルスソースを一覧表示するには、gcloud compute health-sources list コマンドを使用します。
gcloud compute health-sources list \
--regions=REGION
REGION は、ヘルスソースのリージョンに置き換えます。
API
リージョン内のすべての健康データソースを一覧表示するには、regionHealthSources.list メソッドにリクエストを送信します。
HTTP メソッドと URL:
GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthSources
次のように置き換えます。
PROJECT_ID: ヘルスソースのプロジェクト ID。REGION: ヘルスソースのリージョン。
ヘルスソースの説明を取得する
ヘルスソースの説明を取得して、その詳細を表示できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[健康状態のソース] をクリックします。
説明するヘルスソースの名前をクリックします。
gcloud
gcloud compute health-sources describe コマンドを使用します。
gcloud compute health-sources describe HEALTH_SOURCE \
--region=REGION
次のように置き換えます。
HEALTH_SOURCE: ヘルスソースの名前REGION: ヘルスソースのリージョン
API
リクエストを regionHealthSources.get メソッドに送信します。
HTTP メソッドと URL:
GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthSources/HEALTH_SOURCE
次のように置き換えます。
PROJECT_ID: ヘルスソースのプロジェクト ID。REGION: ヘルスソースのリージョン。HEALTH_SOURCE: ヘルスソースの名前。
ヘルスソースを更新する
既存のヘルスソースの説明、バックエンド サービス、ヘルス集約ポリシーを更新できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[健康状態のソース] をクリックします。
更新するヘルスソースの名前をクリックします。
[ 編集] をクリックします。
変更するフィールドを更新します。
[保存] をクリックします。
gcloud
gcloud compute health-sources update コマンドを使用します。更新しないプロパティのフラグは省略します。
gcloud compute health-sources update HEALTH_SOURCE \
--region=REGION \
--description="DESCRIPTION" \
--sources=BACKEND_SERVICE \
--health-aggregation-policy=POLICY
次のように置き換えます。
HEALTH_SOURCE: 更新するヘルスソースの名前REGION: ヘルスソースのリージョンDESCRIPTION: ヘルスソースの更新された説明BACKEND_SERVICE: 正常性のソースとして使用するバックエンド サービスの名前バックエンド サービスは次の要件を満たす必要があります。
- ロード バランシング スキームは
INTERNALまたはINTERNAL_MANAGEDである必要があります。 - 作成するヘルスソースと同じリージョンに存在する必要があります。
- バックエンドは、タイプ
GCE_VM_IPまたはGCE_VM_IP_PORTのインスタンス グループまたはネットワーク エンドポイント グループである必要があります。
- ロード バランシング スキームは
POLICY: このヘルスソースに適用する更新されたヘルス集計ポリシーの名前。
API
- ヘルスソースを説明し、
fingerprintキーの値をメモします。この値は次のステップで使用します。 リクエストを
regionHealthSources.patchメソッドに送信します。更新しないプロパティのフィールドは省略します。HTTP メソッドと URL:
PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthSources/HEALTH_SOURCE
リクエストの本文(JSON):
{ "description": "DESCRIPTION", "sources": [ "projects/PROJECT_ID/regions/REGION/backendServices/BACKEND_SERVICE" ], "healthAggregationPolicy": "projects/PROJECT_ID/regions/REGION/healthAggregationPolicies/POLICY", "fingerprint": "FINGERPRINT" }次のように置き換えます。
PROJECT_ID: ヘルスソースのプロジェクト ID。REGION: ヘルスソースのリージョン。HEALTH_SOURCE: 更新するヘルスソースの名前。DESCRIPTION: ヘルスソースの更新された説明。BACKEND_SERVICE: 正常性のソースとして使用するバックエンド サービスの名前。バックエンド サービスは次の要件を満たす必要があります。
- ロード バランシング スキームは
INTERNALまたはINTERNAL_MANAGEDである必要があります。 - 作成するヘルスソースと同じリージョンに存在する必要があります。
- バックエンドは、タイプ
GCE_VM_IPまたはGCE_VM_IP_PORTのインスタンス グループまたはネットワーク エンドポイント グループである必要があります。
- ロード バランシング スキームは
POLICY: このヘルスソースに適用する更新されたヘルス集計ポリシー。FINGERPRINT: 前の手順で確認したfingerprintキーの最新の値。
ヘルスソースを削除する
ヘルスソースは、既存の複合ヘルスチェックに関連付けられていない場合に削除できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[健康状態のソース] をクリックします。
削除する健康状態ソースの横にあるチェックボックスをオンにします。
[削除] をクリックします。
[削除] をクリックして確定します。
gcloud
gcloud compute health-sources delete コマンドを使用します。
gcloud compute health-sources delete HEALTH_SOURCE \
--region=REGION
次のように置き換えます。
HEALTH_SOURCE: 削除するヘルスソースの名前REGION: ヘルスソースのリージョン
API
リクエストを regionHealthSources.delete メソッドに送信します。
HTTP メソッドと URL:
DELETE https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/healthSources/HEALTH_SOURCE
次のように置き換えます。
PROJECT_ID: ヘルスソースのプロジェクト ID。REGION: ヘルスソースのリージョン。HEALTH_SOURCE: 削除するヘルスソースの名前。
複合ヘルスチェックを管理する
以降のセクションでは、複合ヘルスチェックを管理する方法について説明します。
複合ヘルスチェックを一覧表示する
構成した複合ヘルスチェックの一覧を取得できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[複合ヘルスチェック] をクリックします。
gcloud
リージョン内のすべての複合ヘルスチェックを一覧表示するには、gcloud compute composite-health-checks list コマンドを使用します。
gcloud compute composite-health-checks list \
--regions=REGION
REGION は、複合ヘルスチェックのリージョンに置き換えます。
API
リージョン内のすべての複合ヘルスチェックを一覧表示するには、regionCompositeHealthChecks.list メソッドにリクエストを送信します。
HTTP メソッドと URL:
GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/compositeHealthChecks
次のように置き換えます。
PROJECT_ID: 複合ヘルスチェックのプロジェクト ID。REGION: 複合ヘルスチェックのリージョン。
複合ヘルスチェックの説明を取得する
複合ヘルスチェックの説明を取得して、その詳細を表示できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[複合ヘルスチェック] をクリックします。
説明する複合ヘルスチェックの名前をクリックします。
gcloud
gcloud compute composite-health-checks describe コマンドを使用します。
gcloud compute composite-health-checks describe COMPOSITE_HEALTH_CHECK \
--region=REGION
次のように置き換えます。
COMPOSITE_HEALTH_CHECK: 複合ヘルスチェックの名前REGION: 複合ヘルスチェックのリージョン
API
リクエストを regionCompositeHealthChecks.get メソッドに送信します。
HTTP メソッドと URL:
GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/compositeHealthChecks/COMPOSITE_HEALTH_CHECK
次のように置き換えます。
PROJECT_ID: 複合ヘルスチェックのプロジェクト ID。REGION: 複合ヘルスチェックのリージョン。COMPOSITE_HEALTH_CHECK: 複合ヘルスチェックの名前。
複合ヘルスチェックを更新する
複合ヘルスチェックの説明、ヘルスソース、ヘルス宛先を更新できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[複合ヘルスチェック] をクリックします。
更新する複合ヘルスチェックの名前をクリックします。
[ 編集] をクリックします。
変更するフィールドを更新します。
[保存] をクリックします。
gcloud
gcloud compute composite-health-checks update コマンドを使用します。更新しないプロパティのフラグは省略します。
gcloud compute composite-health-checks update COMPOSITE_HEALTH_CHECK \
--region=REGION \
--description="DESCRIPTION" \
--health-sources=HEALTH_SOURCES \
--health-destination=HEALTH_DESTINATION
次のように置き換えます。
COMPOSITE_HEALTH_CHECK: 更新する複合ヘルスチェックの名前REGION: 複合ヘルスチェックのリージョンDESCRIPTION: 更新された説明HEALTH_SOURCES: 複合ヘルスチェックに関連付ける 1 つ以上のヘルスソースの名前複数のヘルスソースをカンマ区切りリストで指定できます。
HEALTH_DESTINATION: この複合ヘルスチェックから複合ヘルス状態を受信する転送ルールの URI(例:projects/PROJECT_ID/regions/REGION/forwardingRules/FORWARDING_RULE)。転送ルールは、複合ヘルスをサポートし、次の要件を満たすプロデューサー ロードバランサに関連付ける必要があります。
- ロード バランシング スキームは
INTERNALまたはINTERNAL_MANAGEDである必要があります。 - 複合ヘルスチェックと同じリージョンに存在する必要があります。
- ロード バランシング スキームは
API
複合ヘルスチェックの説明を取得し、次のステップで使用する
fingerprintキーの値をメモします。リクエストを
regionCompositeHealthChecks.patchメソッドに送信します。更新しないプロパティのフィールドは省略します。HTTP メソッドと URL:
PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/compositeHealthChecks/COMPOSITE_HEALTH_CHECK
リクエストの本文(JSON):
{ "description": "DESCRIPTION", "healthSources": [ "projects/PROJECT_ID/regions/REGION/healthSources/HEALTH_SOURCE" ], "healthDestination": "projects/PROJECT_ID/regions/REGION/forwardingRules/FORWARDING_RULE", "fingerprint": "FINGERPRINT" }次のように置き換えます。
PROJECT_ID: 複合ヘルスチェックのプロジェクト ID。REGION: 複合ヘルスチェックのリージョン。COMPOSITE_HEALTH_CHECK: 更新する複合ヘルスチェックの名前。DESCRIPTION: 更新された説明。HEALTH_SOURCE: 複合ヘルスチェックに関連付けるヘルスソースの名前。複数のヘルスソースを関連付けるには、各ソースをhealthSources配列に追加します。FORWARDING_RULE: この複合ヘルスチェックから複合ヘルス状態を受信する転送ルール。FINGERPRINT: 前の手順で確認したfingerprintキーの最新の値。
複合ヘルスチェックを削除する
複合ヘルスチェックは削除できます。
コンソール
Google Cloud コンソールで、[複合ヘルス] ページに移動します。
[複合ヘルスチェック] をクリックします。
削除する複合ヘルスチェックの横にあるチェックボックスをオンにします。
[削除] をクリックします。
[削除] をクリックして確定します。
gcloud
gcloud compute composite-health-checks delete コマンドを使用します。
gcloud compute composite-health-checks delete COMPOSITE_HEALTH_CHECK \
--region=REGION
次のように置き換えます。
COMPOSITE_HEALTH_CHECK: 削除する複合ヘルスチェックの名前REGION: 複合ヘルスチェックのリージョン
API
リクエストを regionCompositeHealthChecks.delete メソッドに送信します。
HTTP メソッドと URL:
DELETE https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/compositeHealthChecks/COMPOSITE_HEALTH_CHECK
次のように置き換えます。
PROJECT_ID: 複合ヘルスチェックのプロジェクト ID。COMPOSITE_HEALTH_CHECK: 削除する複合ヘルスチェックの名前。REGION: 複合ヘルスチェックのリージョン。