Les API HTTP utilisent le protocole HTTP pour exposer rapidement des services internes au sein d'un système distribué. Cette rubrique explique comment créer une API HTTP dans la console.
Cas d'utilisation
Vous pouvez créer des API au sein ou en dehors d'une instance, selon vos besoins.
Créer une API au sein d'une instance
Gestion dédiée des ressources : l'API gère les ressources ou la logique interne uniquement au sein d'une instance spécifique.
Sécurité et isolation : les données ou fonctionnalités nécessitent une isolation stricte et ne sont appelables qu'à partir de l'intérieur de l'instance.
Configuration simplifiée du service : limiter la configuration à une instance spécifique simplifie la gestion des API.
Créer une API en dehors d'une instance
Accès partagé entre instances : plusieurs instances partagent une seule définition d'API.
Gestion et surveillance centralisées : contrôle unifié des autorisations, journalisation et gestion du trafic.
Les API créées au sein d'une instance sont visibles et peuvent être gérées uniquement dans cette instance.
Les API créées en dehors d'une instance ne peuvent pas être modifiées ni supprimées depuis l'intérieur de l'instance. Vous devez les gérer depuis la liste des API externes.
Créer une API HTTP dans la console
-
Vous pouvez créer une API dans Cloud-native API Gateway de deux manières :
External API
Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, sélectionnez API. Dans la barre de menu supérieure, choisissez une région.
Cliquez sur Create API, puis cliquez sur Create sur la carte HTTP API.
In-instance API
Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, sélectionnez Instance. Dans la barre de menu supérieure, choisissez une région.
Sur la page Instance, cliquez sur l'ID de l'instance de passerelle cible. Dans le volet de navigation de gauche, sélectionnez API. Dans le coin supérieur droit, cliquez sur Create API.
Cliquez sur Create sur la carte HTTP API.
-
Dans le panneau Create REST API, configurez les paramètres et cliquez sur OK.
Élément de configuration
Description
API Name
Nom personnalisé pour l'API. Le nom de l'API doit être unique à l'échelle globale.
Description
Saisissez une description pour l'API.
resource
Sélectionnez le groupe de ressources cible. Vous pouvez cliquer sur Create Resource Group à droite.
Créer une API HTTP en important un Ingress
Prérequis
Vous devez créer une source Container Service dans Cloud-native API Gateway. Pour plus d'informations, consultez la rubrique Gérer les sources de service.
Procédure
-
Vous pouvez créer une API dans Cloud-native API Gateway de deux manières :
Outside an instance
Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, sélectionnez API. Dans la barre de menu supérieure, choisissez une région.
Cliquez sur Create API, puis cliquez sur Import Ingress sur la carte HTTP API.
In-instance API
Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, sélectionnez Instance. Dans la barre de menu supérieure, choisissez une région.
Sur la page Instance, cliquez sur l'ID de l'instance de passerelle cible. Dans le volet de navigation de gauche, sélectionnez API. Dans le coin supérieur droit, cliquez sur Create API.
Cliquez sur Import Ingress sur la carte HTTP API.
-
Dans la section HTTP API, cliquez sur Import Ingress. Sur la page Import Ingress, configurez les paramètres Ingress et cliquez sur OK.
Élément de configuration
Description
API Name
Nom de l'API. Vous pouvez également cliquer sur Add Description pour ajouter une description au routage.
Description
Description de l'API. Elle peut contenir jusqu'à 255 caractères.
Instance
Sélectionnez l'instance Cloud-native API Gateway.
Source Cluster
La source de service correspond au cluster Container Service où réside l'Ingress.
resource
Sélectionnez le groupe de ressources.
Namespace
Le namespace à surveiller. Si vous laissez ce champ vide, la passerelle surveille les ressources Ingress dans tous les namespaces.
IngressClass
L'IngressClass à surveiller. Si vous laissez ce champ vide, la passerelle surveille tous les types de ressources Ingress.
Update Ingress Status
Si vous activez cette fonctionnalité, le point de terminaison Status dans l'Ingress surveillé est remplacé par le point de terminaison d'entrée de la passerelle.