Gérer les instances

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

Consultez la documentation d'Apigee Edge.

Une instance est une machine virtuelle qui stocke votre projet d'API et les services associés. Les instances correspondent aux régions. Généralement, vous commencez avec une seule instance et ajoutez de nouvelles instances à mesure que votre organisation se développe dans d'autres régions. Cette section explique comment effectuer les opérations suivantes :

Créer une instance

Pour créer une instance, vous pouvez utiliser l'API Instances ou l'interface utilisateur d'Apigee. Chaque instance requiert :

  • Sa propre clé de chiffrement de disque pour le réseau. Apigee vous recommande de créer également un trousseau de clés distinct pour la nouvelle instance. Pour plus d'informations, voir À propos des clés de chiffrement Apigee.
  • Ses propres plages CIDR /22 et /28 sans chevauchement pour l'appairage de réseaux. Les plages ne peuvent pas être partagées entre plusieurs instances.

Apigee dans la console Cloud

Pour créer une instance dans Apigee dans la console Cloud, procédez comme suit :

  1. Ouvrez la page https://console.cloud.google.com/apigee dans votre navigateur.

  2. Sélectionnez Gestion > Instances. Le volet Instances affiche la liste des instances existantes.

  3. Cliquez sur + Créer. Il peut y avoir un délai pendant que l'interface utilisateur détermine si votre organisation dispose des droits appropriés pour créer une instance.

    La page Créer une instance s'affiche :

  4. Saisissez les informations de votre nouvelle instance dans les champs suivants :
    Champ Obligatoire Description
    Runtime hosting location Requis Sélectionnez la région dans laquelle vous souhaitez créer votre instance. Vous ne pouvez pas créer une instance dans une région qui en dispose déjà. Pour en savoir plus sur l'utilisation de plusieurs régions, consultez la page Utiliser plusieurs régions.
    Name Requis

    Saisissez l'ID de la nouvelle instance

    La valeur par défaut est le nom de la région d'hébergement de l'environnement d'exécution que vous avez sélectionnée, mais vous pouvez la remplacer par le nom que vous souhaitez, tant que vous suivez les règles de dénomination :

    • Longueur minimale : 2.
    • Longueur maximale de 32 caractères.
    • N'utilisez que des lettres minuscules, des chiffres et des traits d'union (en suivant le format /^[a-z0-9\-]+$/).
    • Doit commencer par une lettre ; ne débute pas par des chiffres ou trait d'union.
    • Doit se terminer par un chiffre ou une lettre ; ne comporte aucun tiret final.
    • Doit être unique au sein de votre organisation.
    IP range allocation Requis

    Spécifiez la manière dont vous souhaitez allouer une plage d'adresses IP. Choisissez l'une des options suivantes :

    • Automatique (recommandée) : Apigee sélectionne une plage CIDR disponible avec une taille de préfixe de /22. Aucune action supplémentaire de votre part n'est nécessaire.
    • Personnalisé : dans les cas d'utilisation avancés, vous devrez peut-être spécifier exactement la plage d'adresses IP que vous souhaitez utiliser avec Apigee. Dans ces cas, vous spécifiez une plage d'adresses IP personnalisée avec une taille de préfixe de /22. La plage doit être disponible dans le cadre d'une connexion privée entre votre projet et Apigee.
    Disk encryption key Requis

    Sous Disk encryption key (Clé de chiffrement du disque), choisissez une clé de chiffrement gérée par le client. Si une clé existe déjà, vous pouvez la choisir. L'assistant répertorie toutes les clés du même emplacement que la région hébergeant l'environnement d'exécution sur tous les trousseaux de clés. S'il n'existe aucune clé ou si vous ne souhaitez pas utiliser une clé qui existe déjà, vous pouvez en créer une à partir de l'assistant. Pour créer une clé :

    1. Cliquez sur Créer une clé.
    2. Sélectionnez un trousseau de clés ou, à défaut, activez l'option Create key ring (Créer un trousseau de clés) et saisissez un nom de trousseau de clés, puis sélectionnez un emplacement de trousseau de clés. Les noms des trousseaux de clés peuvent contenir des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-). Les trousseaux de clés ne peuvent être ni renommés, ni supprimés.
    3. Cliquez sur Continuer.
    4. Créez une clé. Saisissez un nom et un niveau de protection. Notez que les noms de clé peuvent contenir des lettres, des chiffres, des traits de soulignement (_) et des tirets (-). Les clés ne peuvent être ni renommées, ni supprimées. Pour le niveau de protection, Logiciel est un bon choix. Cloud KMS utilise le même niveau de protection par défaut. Vous pouvez toutefois le modifier si vous le souhaitez.
    5. Cliquez sur Continue (Continuer) et vérifiez vos sélections.
    6. Cliquez sur Créer.
    7. Cliquez sur Accorder pour autoriser le compte de service à chiffrer/déchiffrer des données à l'aide de la clé sélectionnée.
    Environments Facultatif

    Sélectionnez les environnements que vous souhaitez associer à cette instance. Pour ce faire, cliquez sur la liste déroulante Environnements et cochez les cases situées à côté des environnements que vous souhaitez associer. Vous pouvez effectuer cette opération pour autant d'environnements que vous le souhaitez. Cliquez sur OK.

    Notez que les environnements de toutes les instances sont comptabilisés dans le nombre total d'environnements que vous pouvez allouer. Pour en savoir plus, consultez la section À propos des environnements et des groupes d'environnements :

    L'ajout d'environnements lors de la création d'une instance est facultatif. Si vous ne les ajoutez pas maintenant, vous pouvez utiliser l'API de création de rattachements d'instances ou l'interface utilisateur pour les ajouter et les supprimer ultérieurement. Consultez la section Associer ou supprimer un environnement.
    Accepted projects Facultatif Cliquez sur Ajouter un projet accepté pour sélectionner un ou plusieurs projets Cloud. Les projets sélectionnés peuvent se connecter en mode privé au rattachement de service pour votre instance. Par défaut, le projet associé à votre organisation Apigee est inclus dans cette liste.
    Enable logging Facultatif Cliquez sur le bouton Activer la journalisation pour activer les journaux d'accès aux entrées Cloud Logging pour l'instance. Cette fonctionnalité vous permet d'afficher les journaux générés par les passerelles d'entrée dans votre infrastructure Apigee, telles qu'un équilibreur de charge d'application externe ou une passerelle Anthos, afin de faciliter la résolution des problèmes liés aux appels d'API Apigee.

    Pour plus d'informations, consultez la section Journaliser les journaux d'accès Apigee.
    Filter Facultatif Sélectionnez un code de réponse HTTP dans la zone Code de réponse pour servir de filtre pour les journaux d'accès aux entrées.

    Si vous souhaitez inclure tous les journaux, quel que soit le code de réponse HTTP, sélectionnez None (all HTTP responses).

    Pour créer un filtre personnalisé, sélectionnez Custom et saisissez le filtre au format suivant :

    status_code > XX && status code <= YY

    Par exemple :

    status_code >= 500 && status_code < 504

    Si votre organisation ne peut pas créer d'instance, contactez le service commercial d'Apigee.

  5. Cliquez sur Créer.

    Apigee lance une opération de longue durée qui peut prendre 20 minutes ou plus. Une fois cette opération terminée, la nouvelle instance apparaît dans la liste des instances de l'interface utilisateur Instances.

API Apigee

Si Apigee a été provisionné sans appairage de VPC, consultez la section Créer une instance d'exécution dans les étapes de provisionnement sans appairage de VPC.

Si Apigee a été provisionné avec l'appairage de VPC, consultez la section Créer une instance d'exécution dans les étapes de provisionnement avec appairage de VPC.

Associer des environnements à une instance ou les supprimer

Lorsque vous créez un environnement à l'aide de l'interface utilisateur Apigee dans la console Google Cloud, vous avez la possibilité d'attribuer l'environnement à une instance existante. Pour plus d'informations, consultez la section Créer un environnement dans l'interface utilisateur.

Si vous n'avez pas associé votre environnement à une instance lors de sa création, ou si vous souhaitez supprimer un environnement d'une instance, procédez comme suit. Pour plus d'informations sur les environnements et les instances, consultez la page Environnements et instances.

Pour associer ou supprimer un environnement d'une instance à l'aide d'Apigee dans la console Cloud, procédez comme suit :

  1. Ouvrez la page https://console.cloud.google.com/apigee dans votre navigateur.
  2. Sélectionnez Gestion > Instances.

  3. Cliquez sur l'instance à modifier.

  4. Sur la page Détails de l'instance, cliquez sur Modifier.
  5. Sur la page Modifier l'instance, cliquez sur le champ Environnements (facultatif) et sélectionnez l'environnement que vous souhaitez associer à l'instance, ou désélectionnez l'environnement que vous souhaitez supprimer.
  6. Cliquez sur OK.
  7. Cliquez sur Enregistrer pour enregistrer les modifications.

En plus d'utiliser l'interface utilisateur, vous pouvez également associer des environnements à une instance à l'aide de l'API de création de rattachements d'instances. Pour obtenir un exemple, consultez la section Créer un environnement dans la documentation sur le provisionnement de la ligne de commande.

Modifier la liste des projets acceptés

Vous pouvez ajouter ou supprimer des projets dans la liste des projets acceptés :

  1. Ouvrez la page https://console.cloud.google.com/apigee dans votre navigateur.
  2. Sélectionnez Gestion > Instances.

  3. Cliquez sur l'instance à modifier.

  4. Sur la page Détails de l'instance, cliquez sur Modifier.
  5. Dans la section Projets acceptés de la page Modifier l'instance, cliquez sur l'icône de suppression située à côté d'un projet pour le supprimer. Pour ajouter un projet, cliquez sur Ajouter un projet accepté, puis saisissez l'ID du projet à ajouter.
  6. Cliquez sur Enregistrer pour enregistrer les modifications.

Activer ou désactiver les journaux d'accès aux entrées pour une instance

Après avoir créé une instance, vous pouvez activer et désactiver les journaux d'accès aux entrées Cloud Logging pour l'instance :

  1. Ouvrez la page https://console.cloud.google.com/apigee dans votre navigateur.
  2. Sélectionnez Gestion > Instances.

  3. Cliquez sur l'instance à modifier.

  4. Sur la page Détails de l'instance, cliquez sur Modifier.
  5. Sur la page Modifier l'instance, cliquez sur le bouton Activer la journalisation pour désactiver la fonctionnalité.
  6. Cliquez sur Enregistrer pour enregistrer les modifications.

Supprimer une instance

Vous pouvez utiliser la page https://console.cloud.google.com/apigee pour supprimer une instance existante, comme décrit dans cette section. Vous pouvez également supprimer une instance à l'aide de l'API Instances.

Une seule instance Apigee peut se trouver dans une région Google Cloud donnée. Lorsque vous supprimez une instance, elle est complètement supprimée de sa région. Consultez également la section Installation multirégionale.

Avertissement : Lorsque vous supprimez une instance, toutes les données associées sont perdues. Cette étape est irréversible. Toutefois, notez que si vous disposez de plusieurs instances, par exemple dans une installation multirégionale, vos données ne seront perdues que si vous supprimez toutes les instances. Avant de supprimer la dernière instance, veillez à extraire et à sauvegarder les données que vous ne souhaitez pas perdre.

Les données suivantes sont stockées dans une instance Apigee et seront supprimées si vous supprimez l'instance :

Type de données Description
Système de gestion des clés (KMS) Les données KMS incluent des produits d'API, des développeurs, des applications de développeur, des jetons OAuth (y compris des jetons d'accès, des jetons d'actualisation et des codes d'autorisation), et des clés API. Utilisez la règle AccessEntity ou l'API Apigee associée pour récupérer les données que vous souhaitez enregistrer.
Mappage clé-valeur (KVM) Toutes les données pouvant être créées ou gérées avec des règles KVM. Consultez la section Récupérer des mappages clé-valeur.
Quota Définitions de quotas, buckets et compteurs
Cache de l'environnement Toutes les données mises en cache

Pour supprimer une instance Apigee à l'aide de l'interface utilisateur d'Apigee dans la console Cloud :

  1. Ouvrez la page https://console.cloud.google.com/apigee dans votre navigateur.

  2. Sélectionnez Gestion > Instances.

  3. Sélectionnez l'instance que vous souhaitez supprimer.
  4. Sur la page Détails de l'instance, cliquez sur Supprimer.