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

このページの内容は Apigee を対象としています。Apigee ハイブリッドは対象としていません。

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

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

メンテナンスのための優先時間枠を設定する

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

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

  • 更新の順序が Week 1 に設定されている場合、Apigee は少なくとも 1 週間前にメンテナンス通知を送信します。
  • 更新の順序が Week 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, Maintenance window] の行で、[メール] の下のラジオボタンを選択してオンにします。

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