Apigee インスタンスのメンテナンスの時間枠を管理する

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

このセクションでは、Apigee リソースのメンテナンスの時間枠の検索と設定の手順を説明します。Apigee がメンテナンスを行う方法とその理由の詳細は、メンテナンスの概要をご覧ください。

メンテナンスに優先時間枠を設定する

リソースがすでにメンテナンス中であるかメンテナンス スケジュールが設定されているときに、メンテナンスの時間枠の設定を変更した場合、変更はすぐには反映されません。これらの変更は、将来のメンテナンス イベントに反映されます。

メンテナンス通知を有効にしている場合、リソースのメンテナンスがスケジュールされると、Apigee はメンテナンスが予定されている正確な日時を含む通知を送信します。Apigee は、リソースのメンテナンスの時間枠の更新順序設定に基づいてこれらの通知を送信します。

  • 更新の順序が Week 1 に設定されている場合、Apigee は少なくとも 1 週間前にメンテナンス通知を送信します。
  • 更新の順序が「第 2 週」に設定されている場合、Apigee は少なくとも 2 週間前にメンテナンス通知を送信します。

Apigee インスタンスごとに指定できるメンテナンスの時間枠は 1 つだけです。複数のメンテナンス ウィンドウを含むリクエストは拒否されます。

同じ組織内の複数のインスタンスにメンテナンスの時間枠を設定する場合は、メンテナンス オペレーションの重複を避けるため、メンテナンスの時間枠の間に少なくとも 12 時間の間隔を空ける必要があります。

メンテナンスの時間枠を更新すると、以前の時間枠が上書きされます。

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"
curl -X PATCH \
  -H "$AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "maintenanceUpdatePolicy": {
      "maintenanceWindows": [
        {
          "day": "SUNDAY",
          "startTime": {
            "hours": 23
          }
        }
      ],
      "maintenanceChannel": "WEEK1"
    }
  }' \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID?updateMask=maintenanceUpdatePolicy.maintenanceWindows,maintenanceUpdatePolicy.maintenanceChannel"

各要素の意味は次のとおりです。

  • メンテナンス startTime は UTC で構成されています。
  • ORGANIZATION_ID は Apigee 組織 ID です。
  • INSTANCE_ID は Apigee インスタンス ID です。

既存のメンテナンス設定とメンテナンス スケジュールを確認する

次の API の例に示すように、maintenanceUpdatePolicy フィールドと scheduledMaintenance フィールドを確認することで、現在のメンテナンス設定を取得し、今後のメンテナンスを確認できます。

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"
curl -H "$AUTH" \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID"

ここで

  • ORGANIZATION_ID は Apigee 組織 ID です。
  • INSTANCE_ID は Apigee インスタンス ID です。

出力例

{
  ...
  "scheduledMaintenance": {
    "startTime": "2025-01-28T23:00:00Z"
  },
  "maintenanceUpdatePolicy": {
    "maintenanceWindows": [
      {
        "day": "SUNDAY",
        "startTime": {
          "hours": 23
        }
      }
    ]
  }
}

メンテナンス設定をクリアする

メンテナンス設定が不要になった場合は、以下の手順でクリアできます。

AUTH="Authorization: Bearer $(gcloud auth print-access-token)"
curl -X PATCH \
  -H "$AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "maintenanceUpdatePolicy": null
  }' \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION_ID/instances/INSTANCE_ID?updateMask=maintenanceUpdatePolicy"

ここで

  • ORGANIZATION_ID は Apigee 組織 ID です。
  • INSTANCE_ID は Apigee インスタンス ID です。

メンテナンス通知を有効にする

メンテナンス通知を有効にする前に、リソースの メンテナンスに優先時間枠を設定する必要があります。

  1. Google Cloud コンソールで、[ユーザー設定>コミュニケーション] ページに移動します。

    [コミュニケーション] に移動

  2. [Apigee、メンテナンスの時間枠] の行で、[メール] の下のラジオボタンを選択して [オン] にします。

通知を受け取る必要があるユーザーごとに、上記の手順に沿って個別にオプトインする必要があります。