Création d'une passerelle d'API

1. Dans la page de liste Passerelles, sélectionnez Créer une passerelle. Si vous avez besoin d'aide pour trouver la page de liste, voir Liste des passerelles d'API.

2. Spécifiez les valeurs suivantes pour la nouvelle passerelle d'API :

   • Nom : Nom de la passerelle d'API. Évitez d'entrer des informations confidentielles.
   • Type : Type de passerelle d'API à créer.
     • Sélectionnez Privé si vous voulez que la passerelle d'API (et les API déployées sur celle-ci) soient accessibles par les ressources du même réseau privé (VCN) ou par les ressources d'autres réseaux privés ou sur place appairés à ce réseau privé.
     • Sélectionnez Publique si vous voulez que la passerelle d'API (et les API déployées sur celle-ci) soient accessibles publiquement. Les passerelles d'API publiques peuvent être atteintes à partir d'Internet, à condition qu'une passerelle Internet soit présente dans le VCN de la passerelle d'API.
   • compartiment : compartiment dans lequel créer la passerelle d'API.
   • Réseau en nuage virtuel dans <compartment-name> : VCN dans lequel créer la passerelle d'API. Le VCN peut se trouver dans le même compartiment que la passerelle d'API, mais il n'est pas nécessaire de le faire.
   • Sous-réseau dans <compartment-name> : Sous-réseau régional public ou privé dans lequel créer la passerelle d'API. Si vous voulez créer une passerelle d'API publique, vous devez spécifier un sous-réseau régional public.

     Notez que le service de passerelle d'API communique sur le port 443, qui n'est pas ouvert par défaut. Vous devez ajouter une nouvelle règle de sécurité de trafic entrant avec état pour le sous-réseau régional (dans une liste de sécurité ou un groupe de sécurité de réseau) pour permettre le trafic sur le port 443. Pour les propriétés de la règle de sécurité de trafic entrant, voir Créer un réseau VCN à utiliser avec la passerelle d'API, si celui-ci n'existe pas déjà.

   • Activer les groupes de sécurité de réseau : Sélectionnez cette option pour contrôler l'accès à la passerelle d'API et à partir de celle-ci à l'aide des règles de sécurité définies pour un ou plusieurs groupes de sécurité de réseau que vous spécifiez (cinq groupes de sécurité de réseau au maximum). Vous pouvez utiliser les règles de sécurité définies pour les groupes de sécurité de réseau au lieu ou en plus de celles définies pour les listes de sécurité. Les groupes de sécurité de réseau peuvent appartenir au même compartiment que la nouvelle passerelle d'API, mais n'ont pas à le faire. Voir Groupes de sécurité de réseau.
   • Certificat : Certificat TLS utilisé par la passerelle d'API. Le certificat TLS que vous sélectionnez détermine le nom de domaine de la passerelle d'API.
     • Par défaut (*.oci.customer-oci.com) (si affiché) : Sélectionnez cette option si vous souhaitez que le nom de domaine soit généré automatiquement et que la passerelle d'API utilise un certificat TLS par défaut obtenu par le service de passerelle d'API. Le nom de domaine par défaut généré contiendra une chaîne aléatoire de caractères suivie de .apigateway.<region-identifier>.oci.customer-oci.com. Par exemple : laksjd.apigateway.us-phoenix-1.oci.customer-oci.com. Cette option n'est disponible que si votre location existe dans le domaine OC1.
     • Catégorie du service de certificats (le cas échéant) : Sélectionnez une ressource de certificat du service de certificats existante qui contient les détails du certificat TLS personnalisé que vous voulez que la passerelle d'API utilise. La passerelle d'API utilise un nom de domaine personnalisé associé au certificat que vous sélectionnez. Cette catégorie s'affiche uniquement si les ressources de certificat du service de certificats sont disponibles dans le compartiment sélectionné.
     • Catégorie de certificats du service de passerelle d'API (le cas échéant) : Sélectionnez une ressource de certificat du service de passerelle d'API existante qui contient les détails du certificat TLS personnalisé que vous voulez que la passerelle d'API utilise. La passerelle d'API utilise un nom de domaine personnalisé associé au certificat que vous sélectionnez. Cette catégorie s'affiche uniquement si des ressources de certificat du service de passerelle d'API sont disponibles dans le compartiment sélectionné.

     Voir Configuration des domaines et des certificats TLS personnalisés.

     Note
     
     

     Nous recommandons d'utiliser un certificat TLS personnalisé pour les systèmes publics ou de production. Nous recommandons d'utiliser un certificat TLS par défaut obtenu par le service de passerelle d'API uniquement pour des systèmes privés ou hors production (par exemple, pour le développement et le test).

3. Facultativement, sélectionnez Afficher les options avancées et spécifiez les valeurs suivantes :
   • Mise en mémoire cache des réponses : Options permettant d'activer et de configurer la mise en mémoire cache des réponses pour la passerelle d'API afin d'améliorer la performance et de réduire la charge des services dorsaux. Voir Mise en cache des réponses pour améliorer les performances.
   • Autorités de certification : Une ou plusieurs ressources d'autorité de certification ou d'ensemble AC à ajouter au magasin de certificats SSL de la passerelle d'API en tant qu'autorités de certification personnalisées et ensembles AC personnalisés (en plus de l'ensemble AC par défaut). Les autorités de certification personnalisées et les ensembles AC personnalisés sont utilisés pour vérifier les certificats TLS présentés par les clients d'API et les services dorsaux. Voir Personnalisation des magasins de certificats pour la vérification des certificats TLS.
   • Marqueurs : Si vous êtes autorisé à créer une ressource, vous disposez également des autorisations nécessaires pour appliquer des marqueurs à structure libre à cette ressource. Pour appliquer un marqueur défini, vous devez être autorisé à utiliser l'espace de noms de marqueur. Pour plus d'informations sur le marquage, voir Marqueurs de ressource. Si vous ne savez pas si vous devez appliquer des marqueurs, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des marqueurs plus tard.
     Note
     
     Si vous appliquez un marqueur défini à une passerelle d'API (directement ou en tant que marqueur par défaut pour un compartiment) et que vous modifiez ensuite la définition du marqueur, la passerelle d'API peut entrer un état d'échec. Appliquez un marqueur défini à une passerelle d'API seulement si le marqueur défini ne va pas être modifié. Si vous ne savez pas si un marqueur défini va changer, nous vous recommandons de ne pas l'appliquer à une passerelle d'API.

4. Sélectionnez Créer une passerelle pour créer immédiatement la passerelle d'API.

   Sachez que la création de la passerelle d'API peut prendre quelques minutes. Lors de sa création, la passerelle d'API est affichée avec l'état Création. Lorsqu'elle a été créée avec succès, son statut passe à Active.

   Notez également que, plutôt que de créer immédiatement la passerelle d'API, vous pourrez la créer ultérieurement à l'aide du gestionnaire de ressources et de Terraform, en sélectionnant Enregistrer en tant que pile pour enregistrer la définition de ressource en tant que configuration Terraform. Pour plus d'informations sur l'enregistrement des piles à partir des définitions de ressource, voir Création d'une pile à partir d'une page de création de ressource.

5. Si vous avez attendu pendant plus de quelques minutes pour que la passerelle d'API soit affichée avec l'état Active (ou si l'opération de création de la passerelle d'API a échoué), effectuez les actions suivantes :

   1. Sélectionnez le nom de la passerelle d'API et sélectionnez Demandes de travail pour voir un aperçu de l'opération de création de la passerelle d'API.
   2. Sélectionnez l'opération Créer une passerelle pour voir plus d'informations sur l'opération (notamment les messages d'erreur, les messages de journal et le statut des ressources associées).
   3. Si l'opération de création de la passerelle d'API a échoué et que vous ne pouvez pas diagnostiquer la cause du problème à partir des informations de la demande de travail, voir Dépannage de passerelle d'API.

Après avoir créé une passerelle d'API, vous pouvez la déployer. Voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API.