Gérer les intervalles de maintenance des instances Apigee

Cette page s'applique à Apigee et à 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 présentation de la maintenance.

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

Si vous modifiez le paramètre d'intervalle de maintenance alors que la maintenance de la ressource est déjà en cours ou planifiée, ces modifications ne prennent pas effet immédiatement. Ces modifications seront reflétées dans les futurs événements de maintenance.

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 maintenance des paramètres de mise à jour de votre ressource, comme suit :

• 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 demandes comportant plusieurs intervalles de maintenance seront refusées.

Si vous souhaitez définir des intervalles de maintenance pour plusieurs instances de 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 modifiez 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ù :

• La maintenance startTime est configurée en UTC.
• ORGANIZATION_ID est l'ID de votre organisation Apigee.
• INSTANCE_ID est l'ID de votre instance Apigee.

Rechercher les paramètres et les plannings de maintenance existants

Vous pouvez récupérer vos paramètres de maintenance actuels et afficher toute maintenance à venir en vérifiant 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
        }
      }
    ]
  }
}

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 console Google Cloud , accédez à la page Préférences utilisateur > Communication.

   Accéder à Communications

2. Sur la ligne Apigee, Intervalle de maintenance, cochez la case d'option 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.