Wartungsfenster für Apigee-Instanzen verwalten

Diese Seite gilt für Apigee, aber nicht für Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

In diesem Abschnitt werden Vorgehensweisen beschrieben, mit denen Sie Wartungsfenster für Apigee-Ressourcen ermitteln und einrichten. Weitere Informationen dazu, wie und warum Apigee Wartungsarbeiten durchführt, finden Sie unter Wartung – Übersicht.

Bevorzugtes Wartungsfenster festlegen

Wenn eine Ressource bereits gewartet wird oder ein Wartungsereignis geplant ist, gelten alle Änderungen, die Sie an der Einstellung für das Wartungsfenster vornehmen (einschließlich der Änderung des Tages/der Uhrzeit, der Änderung der Aktualisierungsreihenfolge oder des Löschens der Einstellungen), nicht für das anstehende Ereignis. Die geplante Wartung wird wie geplant durchgeführt und Ihre Änderungen gelten nur für zukünftige Wartungs-Roll-outs.

Wenn Sie Wartungsbenachrichtigungen aktiviert haben, sendet Apigee Ihnen Benachrichtigungen mit dem genauen Datum und der Uhrzeit, wenn eine Wartung geplant ist. Apigee sendet diese Benachrichtigungen basierend auf den Einstellungen für die Reihenfolge der Updates für das Wartungsfenster Ihrer Ressource:

Hinweis: „Woche 1“ und „Woche 2“ beziehen sich auf die Einführungsphasen und Benachrichtigungsfristen (1 Woche im Vergleich zu 2 Wochen). Sie beziehen sich nicht auf die erste oder zweite Kalenderwoche des Monats. Ein Roll-out in „Woche 2“ findet beispielsweise nicht unbedingt in der zweiten Woche eines Kalendermonats statt. Sie erfolgt eine Woche nach der Einführung in Woche 1 für die jeweilige Version.

  • Wenn die Reihenfolge der Update-Einstellung auf „Woche 1“ festgelegt ist, sendet Apigee Wartungsbenachrichtigungen mindestens eine Woche im Voraus.
  • Wenn die Reihenfolge der Update-Einstellung auf „Woche 2“ festgelegt ist, sendet Apigee Wartungsbenachrichtigungen mindestens zwei Wochen im Voraus.

Sie können nur ein Wartungsfenster pro Apigee-Instanz angeben. Anträge mit mehr als einem Wartungsfenster werden abgelehnt.

Wenn Sie Wartungsfenster für mehrere Instanzen in derselben Organisation festlegen möchten, sollten Sie darauf achten, dass zwischen den Wartungsfenstern mindestens 12 Stunden liegen, um Überschneidungen bei Wartungsvorgängen zu vermeiden.

Wenn Sie das Wartungsfenster aktualisieren, wird das vorherige Fenster überschrieben.

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"

Wobei:

  • Die Wartung startTime wird in UTC konfiguriert.
  • maintenanceChannel: Der Wartungskanal bzw. die Einstellung für die Reihenfolge der Aktualisierung (z. B. WEEK1 oder WEEK2).
  • ORGANIZATION_ID ist Ihre Apigee-Organisations-ID.
  • INSTANCE_ID ist Ihre Apigee-Instanz-ID.

Bestehende Wartungseinstellungen und Wartungszeitpläne finden

Sie können Ihre aktuellen Wartungseinstellungen abrufen und anstehende Wartungsarbeiten ansehen, indem Sie die Felder maintenanceUpdatePolicy und scheduledMaintenance prüfen, wie im folgenden API-Beispiel gezeigt:

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

Wobei:

  • ORGANIZATION_ID ist Ihre Apigee-Organisations-ID.
  • INSTANCE_ID ist Ihre Apigee-Instanz-ID.

Beispielausgabe

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

Wartungseinstellungen löschen

Wenn Sie die Wartungseinstellungen nicht mehr benötigen, können Sie sie mit der folgenden Anleitung löschen.

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"

Wobei:

  • ORGANIZATION_ID ist Ihre Apigee-Organisations-ID.
  • INSTANCE_ID ist Ihre Apigee-Instanz-ID.

Wartungsbenachrichtigungen aktivieren

Bevor Sie Wartungsbenachrichtigungen aktivieren können, müssen Sie ein bevorzugtes Wartungsfenster für eine Ressource festlegen.

  1. Rufen Sie in der Google Cloud Console die Seite Nutzereinstellungen > Kommunikation auf.

    Zu „Kommunikation“

  2. Wählen Sie in der Zeile für Apigee, Wartungsfenster das Optionsfeld unter E-Mail aus, um diese Option zu aktivieren.

Jeder Nutzer, der Benachrichtigungen erhalten muss, muss separat aktiviert werden. Folgen Sie dazu der Anleitung oben.