Gérer les intervalles de maintenance des instances Apigee

Cette page s'applique à Apigee, mais pas à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Cette section contient des procédures permettant de rechercher et de définir des intervalles de maintenance pour les ressources Apigee. Pour savoir comment et pourquoi Apigee effectue des opérations de maintenance, consultez la page Présentation de la maintenance.

Définir un intervalle souhaité pour les opérations de maintenance

Si une ressource est déjà en cours de maintenance ou si un événement de maintenance est planifié, les modifications que vous apportez au paramètre d'intervalle de maintenance (y compris le changement de jour/heure, la modification de l'ordre de mise à jour ou l'effacement des paramètres) ne s'appliquent pas à l'événement en attente. La maintenance planifiée se déroule comme prévu, et vos modifications ne s'appliquent qu'aux déploiements de maintenance futurs.

Si vous avez activé les notifications de maintenance, Apigee vous envoie des notifications après la planification de maintenance d'une ressource, avec la date et l'heure exactes de la maintenance. Apigee envoie ces notifications en fonction de l'ordre de mise à jour de l'intervalle de maintenance de votre ressource, comme suit :

Remarque : "Semaine 1" et "Semaine 2" font référence aux phases de déploiement et aux délais de notification (une semaine contre deux semaines). Elles ne font pas référence à la première ou à la deuxième semaine civile du mois. Par exemple, un déploiement de la "Semaine 2" ne se produit pas nécessairement au cours de la deuxième semaine d'un mois civil. Il a lieu une semaine après le déploiement de la "Semaine 1" pour cette version spécifique.

  • Si l'ordre des paramètres de mise à jour est défini sur "Semaine 1", Apigee envoie les notifications de maintenance au moins une semaine à l'avance.
  • Si l'ordre des paramètres de mise à jour est défini sur "Semaine 2", Apigee envoie des notifications de maintenance au moins deux semaines à l'avance.

Vous ne pouvez spécifier qu'un seul intervalle de maintenance par instance Apigee. Les requêtes comportant plusieurs intervalles de maintenance seront rejetées.

Si vous souhaitez définir des intervalles de maintenance pour plusieurs instances dans la même organisation, assurez-vous qu'il y a au moins 12 heures entre les intervalles de maintenance pour éviter que les opérations de maintenance ne se chevauchent.

Lorsque vous mettez à jour l'intervalle de maintenance, l'intervalle précédent est remplacé.

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"

Où :

  • Le startTime de la maintenance est configuré au format UTC.
  • maintenanceChannel : canal/ordre de mise à jour de la maintenance (par exemple, WEEK1 ou WEEK2).
  • ORGANIZATION_ID est l'ID de votre organisation Apigee.
  • INSTANCE_ID est l'ID de votre instance Apigee.

Rechercher les paramètres de maintenance et les programmes de maintenance existants

Vous pouvez récupérer vos paramètres de maintenance actuels et afficher toute maintenance à venir en cochant les champs maintenanceUpdatePolicy et scheduledMaintenance, comme indiqué dans l'exemple d'API suivant :

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

Où :

  • ORGANIZATION_ID est l'ID de votre organisation Apigee.
  • INSTANCE_ID est l'ID de votre instance Apigee.

Exemple de résultat :

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

Effacer les paramètres de maintenance

Si vous n'avez plus besoin des paramètres de maintenance, vous pouvez les effacer en suivant les instructions ci-dessous.

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"

Où :

  • ORGANIZATION_ID est l'ID de votre organisation Apigee.
  • INSTANCE_ID est l'ID de votre instance Apigee.

Activer les notifications de maintenance

Avant d'activer les notifications de maintenance, vous devez définir un intervalle souhaité pour les opérations de maintenance sur une ressource.

  1. Dans la Google Cloud console, accédez à la page Préférences utilisateur > Communication.

    Accéder à la page "Communication"

  2. Sur la ligne Apigee, Intervalle de maintenance, cochez la case d'option sous E-mail pour la définir sur Activé.

Chaque utilisateur devant recevoir des notifications doit activer lui-même l'option en suivant les instructions ci-dessus.