Création d'une passerelle d'API

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

2. Indiquez les valeurs suivantes pour la nouvelle passerelle d'API :

   • Nom : nom de la passerelle d'API. Evitez de saisir des informations confidentielles.
   • Type : type de passerelle d'API à créer.
     • Sélectionnez Privé si vous voulez uniquement que la passerelle d'API (et les API déployées dessus) soient accessibles par les ressources du même réseau privé (VCN) ou par les ressources d'autres réseaux privés ou sur site appairés à ce réseau privé.
     • Sélectionnez Public pour que la passerelle d'API (et les API déployées sur celle-ci) soit accessible 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 cloud 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 n'a pas besoin de l'être.
   • Sous-réseau dans <nom- compartiment> : sous-réseau régional public ou privé dans lequel créer la passerelle d'API. Pour créer une passerelle d'API publique, vous devez indiquer un sous-réseau régional public.

     Sachez qu'API Gateway communique sur le port 443, qui n'est pas ouvert par défaut. Vous devez ajouter une nouvelle règle de sécurité entrante avec conservation de statut au sous-réseau régional (dans une liste de sécurité ou dans un groupe de sécurité réseau) afin d'autoriser le trafic sur le port 443. Pour les propriétés de la règle de sécurité entrante, reportez-vous à Création d'un VCN à utiliser avec API Gateway, si aucun n'existe déjà.

   • Activer les groupes de sécurité réseau : sélectionnez cette option pour contrôler l'accès à la passerelle d'API et à partir de celle-ci à l'aide de règles de sécurité définies pour les groupes de sécurité réseau que vous indiquez (jusqu'à cinq groupes de sécurité réseau). Vous pouvez utiliser les règles de sécurité définies pour les groupes de sécurité réseau au lieu ou en plus de celles définies pour les listes de sécurité. Les groupes de sécurité réseau peuvent appartenir au même compartiment que la nouvelle passerelle d'API, mais ce n'est pas obligatoire. Reportez-vous à Groupes de sécurité 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.
     • Valeur par défaut (*.oci.customer-oci.com) (si affichée) : 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 API Gateway. 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 est disponible uniquement si votre location existe dans le domaine OC1.
     • Catégorie Service Certificates (si elle apparaît) : sélectionnez une ressource de certificat de service Certificates existante contenant les détails du certificat TLS personnalisé que la passerelle d'API doit utiliser. La passerelle d'API utilise un nom de domaine personnalisé associé au certificat que vous sélectionnez. Cette catégorie est affichée uniquement si les ressources de certificat du service Certificates sont disponibles dans le compartiment sélectionné.
     • Catégorie Certificats API Gateway (si elle apparaît) : sélectionnez une ressource de certificat API Gateway existante contenant les détails du certificat TLS personnalisé que la passerelle API doit utiliser. La passerelle d'API utilise un nom de domaine personnalisé associé au certificat sélectionné. Cette catégorie est affichée uniquement si les ressources de certificat API Gateway sont disponibles dans le compartiment sélectionné.

     Reportez-vous à Configuration de certificats TLS et de domaines personnalisés.

     Remarque
     
     

     Nous vous 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 API Gateway uniquement pour les systèmes privés ou hors production (par exemple, pour le développement et le test).

3. Sélectionnez éventuellement Afficher les options avancées et indiquez les valeurs suivantes :
   • Mise en cache des réponses : options permettant d'activer et de configurer la mise en cache des réponses pour la passerelle d'API afin d'améliorer les performances et de réduire la charge sur les services back-end. Reportez-vous à Réponses de mise en cache pour l'amélioration des performances.
   • Autorités de certification : ressources d'autorité de certification ou ressources de package d'autorité de certification à ajouter au truststore de la passerelle d'API en tant qu'autorités de certification personnalisées et packages d'autorité de certification personnalisés (en plus du package d'autorité de certification par défaut). Les autorités de certification personnalisées et les packages d'autorité de certification personnalisés sont utilisés pour vérifier les certificats TLS présentés par les clients d'API et les services back-end. Reportez-vous à la section Customizing Trust Stores for TLS Certificate Verification.
   • Balises : si vous avez les droits d'accès nécessaires pour créer une ressource, vous disposez également de droits d'accès nécessaires pour lui appliquer des balises à format libre. Pour appliquer une balise defined, vous devez disposer des droits d'accès permettant d'utiliser l'espace de noms de balise. Pour plus d'informations sur le balisage, reportez-vous à Balises de ressource. Si vous n'êtes pas certain d'appliquer des balises, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des balises ultérieurement.
     Remarque
     
     Si vous appliquez une balise définie à une passerelle d'API (directement ou en tant que valeur de balise par défaut pour un compartiment), puis que vous modifiez la définition de balise, la passerelle d'API peut passer à l'état Echec. Appliquez une balise définie à une passerelle d'API uniquement si la balise définie ne va pas changer. Si vous n'êtes pas sûr de la modification d'une balise définie, nous vous recommandons de ne pas l'appliquer à une passerelle d'API.

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

   La création de la passerelle d'API peut prendre quelques minutes. Pendant sa création, la passerelle d'API a l'état Création en cours. Une fois créée, la passerelle d'API a l'état Actif.

   Notez également que, plutôt que de créer la passerelle d'API immédiatement, vous pouvez la créer ultérieurement à l'aide de Resource Manager 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 de piles à partir de définitions de ressource, reportez-vous à Création d'une pile à partir d'une page de création de ressource.

5. Si vous avez attendu plus de quelques minutes et que la passerelle d'API ne présente pas l'état Actif (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, puis sélectionnez Demandes de travail pour afficher un aperçu de l'opération de création de cette dernière.
   2. Sélectionnez l'opération Créer une passerelle pour afficher des informations supplémentaires sur celle-ci (y compris les messages d'erreur, les messages journaux 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. Reportez-vous à Dépannage d'API Gateway.

Une fois que vous avez créé une passerelle d'API, vous pouvez y déployer une API. Reportez-vous à Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API.