Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'
Apigee Edge.
Les concepts suivants sont des idées courantes ayant une signification particulière dans Apigee.
A
- chemin de base et ressources d'API
- Une API est composée d'un chemin de base et d'un ensemble de ressources (également appelées chemins d'accès aux ressources). Pour chaque API, vous définissez une URL racine unique (également appelée chemin de base) et plusieurs chemins d'accès aux ressources. Une API est semblable à un ensemble d'URI qui partagent tous un chemin de base commun. Pour faciliter la gestion des API, Apigee complète ces URI bruts avec des noms à afficher et des descriptions.
- utilisateur de l'API
- Synonyme de développeur d'applications, qui utilise les API créées par un fournisseur d'API.
- développeur d'API
- Ingénieur logiciel dans l'organisation d'un fournisseur d'API qui crée des API. Ces API permettent aux développeurs d'applications (utilisateurs d'API) de créer des applications.
- produit d'API
- Ensemble de ressources d'API (URI) associé à un forfait et présenté aux développeurs en tant qu'offre groupée. Le produit d'API peut également inclure des métadonnées propres à votre entreprise à des fins de surveillance ou d'analyse. Vous pouvez monétiser une ou plusieurs ressources en les incluant dans des produits d'API, qui peuvent ensuite être regroupés dans un package d'API pour la monétisation.
- fournisseur d'API
- Un fournisseur d'API crée des API (à l'aide d'Apigee) à l'usage des utilisateurs d'API (développeurs d'applications).
- proxy d'API
- Proxy faisant office de façade pour votre API existante. Au lieu d'appeler votre API existante, les développeurs commencent à appeler la nouvelle API générée par Apigee. Cette façade dissocie l'interface publique de votre API backend, ce qui empêche les développeurs d'apporter des modifications au backend, tout en vous permettant d'innover en périphérie sans affecter vos équipes de développement internes. Lorsque vous apportez des modifications au backend, les développeurs continuent à appeler la même API sans interruption. Dans les scénarios plus avancés, Apigee vous permet d'exposer plusieurs interfaces à la même API. Vous pouvez ainsi personnaliser la signature d'une API pour répondre simultanément aux besoins de plusieurs groupes de développeurs.
- API Apigee
- Les points de terminaison que vous pouvez utiliser pour configurer des environnements, des organisations, des proxys d'API et d'autres services hybrides.
- développeur d'applications
- Les développeurs d'applications enregistrent leurs applications auprès d'un fournisseur d'API, ce qui leur permet d'obtenir les clés API dont ils ont besoin pour appeler les proxys d'API du fournisseur.
- applications
- Les développeurs accèdent aux ressources de vos produits d'API à l'aide d'applications. Lorsque vous créez une application, vous sélectionnez le produit d'API à inclure et Apigee génère une clé. Chaque application possède une clé unique permettant d'accéder à plusieurs produits d'API. Les applications vous permettent de contrôler l'accès à vos ressources. Pour contrôler l'accès à vos produits d'API, vous pouvez révoquer et actualiser la clé d'une application. Vous pouvez également contrôler l'accès à des groupes de ressources en révoquant ou en supprimant l'accès aux produits dans une application.
B
- détails du solde
- Dans le cas d'un développeur disposant d'une réserve prépayée, il s'agit du solde de son compte.
C
- Cassandra
(Apigee hybrid uniquement) Dépôt de données d'exécution qui stocke les configurations d'application, les compteurs de quotas distribués, les clés API et les jetons OAuth pour les applications exécutées sur la passerelle.
Il s'agit d'un StatefulSet qui utilise beaucoup de ressources et qui doit se trouver sur un nœud de calcul distinct du processeur de messages.
Pour en savoir plus, consultez la section À propos du plan d'exécution.
- infrastructure de gestion centrale (ou plan)
- Voir plan de gestion.
- image conteneur[isée]
- Voir l'image.
- Plan de contrôle
- Voir plan de gestion.
D
- déployer
Dans Apigee, vous déployez un proxy d'API dans un environnement pour le rendre accessible aux clients d'une application sur Internet, soit publiquement soit en privé, en fonction de la configuration de votre réseau.
- développeur
- Un développeur fait référence à un rôle qu'un utilisateur Apigee peut effectuer.
Il existe deux types de développeurs dans Apigee :
- Développeurs de proxy d'API : ils créent les proxys d'API et appliquent des règles.
- Développeurs d'applications : ils créent les applications qui utilisent des proxys d'API.
- plan tarifaire pour les catégories de développeurs
- Plan tarifaire qui s'applique à tous les développeurs d'une catégorie spécifique et qui est disponible à l'achat pour tous les développeurs de cette catégorie.
- plan tarifaire pour les développeurs
- Plan tarifaire qui s'applique à un développeur spécifique et qui n'est disponible à l'achat que pour ce développeur.
E
- environnement
Un environnement Apigee est un environnement logiciel isolé, au sein d'une organisation, dans lequel vous déployez des proxys d'API. L'environnement peut évoluer pour répondre aux exigences des proxys qui y sont déployés. Vous pouvez créer plusieurs environnements au sein d'une organisation.
- Groupe d'environnements
-
Un groupe d'environnements est un ensemble d'environnements Apigee associés à un seul ou à plusieurs noms d'hôte. Le nom d'hôte fait partie de l'URL utilisée pour appeler les proxys d'API, qui sont déployés dans n'importe quel environnement du groupe d'environnements.
- limite explicite
- Voir limite personnalisée.
G
- GCR
- Google Container Repository.
- GKE
- Google Kubernetes Engine Environnement géré par Google et prêt à l'emploi pour le déploiement d'applications en conteneurs dans Kubernetes. GKE vous permet de configurer Kubernetes en un rien de temps. En effet, dans cet environnement, vous n'avez plus besoin d'installer, de gérer, ni d'exploiter vos propres clusters Kubernetes.
I
- dépôt d'images
- Un groupe d'images de conteneurs partagées.
- limite implicite
- Limite (par exemple, limite de réserve prépayée d'un développeur) définie par la monétisation.
- Entrée/Contrôleur d'entrée
- Application en conteneur qui achemine le trafic provenant de l'extérieur du cluster vers les services du cluster.
K
- KMS
- Service de gestion des clés. Il stocke, conserve et présente des clés et des jetons OAuth permettant de chiffrer et de déchiffrer le trafic. Le service de gestion des clés Apigee gère les clés pour les applications, les développeurs et les produits d'API.
- KVM
- Mappage clé-valeur. Ensemble personnalisé de paires de chaînes clé-valeur chiffrées ou non chiffrées. Pour plus d'informations, consultez la section Utiliser des mappages clés/valeurs.
- machine d'administration Kubernetes
- Machine locale que vous utilisez pour exécuter des commandes sur votre cluster Kubernetes. Il s'agit généralement d'un ordinateur de bureau qui a accès à vos VM Kubernetes.
M
- plan de gestion
- Services centraux hébergés par Google qui communiquent avec le plan d'exécution via des comptes de service.
- MART
L'API des données d'exécution interagit avec le datastore d'exécution local (Cassandra). Il sert de fournisseur d'API pour permettre à l'API Apigee publique d'accéder aux données d'exécution et de les gérer.
MART est une application sans état, tout comme les processeurs de messages. Il s'agit d'une application conteneurisée Kubernetes.
Pour en savoir plus, consultez la section À propos du plan d'exécution.
- nœud maître
- Terme Kubernetes désignant un nœud qui inclut le serveur d'API, cloud-controller-manager (CCM), le programmeur et kube-controller-manager.
- Processeur de messages
-
(Apigee hybrid uniquement) Le processeur de messages évalue les requêtes entrantes, exécute toutes les règles Apigee et appelle les systèmes backend et les autres systèmes pour récupérer les données. Une fois ces réponses reçues, le processeur de messages les met en forme et les renvoie au client.
Le MP est un déploiement Kubernetes. Il est configuré pour un environnement Apigee unique pointant vers un sous-répertoire avec champ d'application au sein du système de fichiers partagé auquel le Synchronisateur fournit des données.
Un MP nécessite beaucoup de ressources et doit se trouver sur un nœud de calcul distinct de Cassandra.
Pour en savoir plus, consultez la section À propos du plan d'exécution.
- monétisation
- Composant d'Apigee offrant un moyen simple et flexible de monétiser des produits d'API.
- montant mensuel utilisé
- Utilisation totale d'un développeur pour un mois donné, comprenant les frais de configuration, les frais de transaction et les frais récurrents.
- paiements mensuels
- Paiements récurrents effectués par un développeur en fonction des forfaits souscrits. Les plans tarifaires peuvent inclure des frais récurrents facturés à un développeur chaque mois, quelle que soit son utilisation.
N
- espace de noms
- Clusters virtuels utilisés pour répartir les ressources du cluster. Les espaces de noms sont destinés aux clusters plus grands comprenant de nombreux utilisateurs. Les clusters plus petits qui ne comportent que des dizaines d'utilisateurs n'ont généralement pas besoin d'espaces de noms.
O
- ajustement ouvert
- Ajustement qui n'a pas encore été appliqué dans les documents de facturation publiés.
- mois de facturation ouvert
- Mois calendaire complet pour lequel les documents de facturation finaux n'ont pas encore été publiés.
- Kubernetes Open Source
- Mise en œuvre de référence de Kubernetes. Voir Kubernetes. L'environnement d'exécution Apigee hybride s'exécute sur un système Kubernetes Open Source et des versions Open Source de Kubernetes conformes à la CNCF.
- organisation
Conteneur pour toutes les entités d'un compte Apigee, telles que les proxys d'API, les produits d'API, les packages d'API, les applications et les développeurs. Dans ce document, les termes organisation Apigee et organisation compatible hybride sont interchangeables.
Pour installer et utiliser Apigee ou Apigee hybrid, vous devez disposer d'une organisation Apigee liée à un projet Google Cloud. L'association s'effectue au moment de créer l'organisation dans un processus appelé provisionnement.
Une organisation Apigee diffère d'une organisation Google Cloud. En cas d'ambiguité, le présent document doit préciser que l'organisation est une organisation Apigee.
Pour plus d'informations, consultez la section Types d'organisations.
P
- pod
- Un pod est le composant fondamental de Kubernetes, l'unité la plus petite et la plus simple du modèle d'objet Kubernetes que vous créez ou déployez. Un pod représente un processus en cours d'exécution sur votre cluster.
- réserve prépayée
- Montant disponible permettant à un développeur disposant d'une réserve prépayée de payer à l'avance des packages d'API.
- développeur disposant d'une réserve prépayée
- Développeur qui paie à l'avance l'utilisation d'un produit d'API. Les fonds sont déduits du solde du développeur lorsqu'il utilise le produit d'API. Le développeur doit conserver une réserve prépayée suffisante pour acheter le produit d'API. Les développeurs se voient attribuer l'état "pré-paiement" ou "post-paiement" par le fournisseur d'API.
- règle
- Étape de traitement exécutée comme une unité de logique atomique et réutilisable dans un flux d'API. Les règles types incluent les requêtes de routage vers le point de terminaison approprié, la transformation d'un format de message, l'application du contrôle des accès, l'appel de services distants pour obtenir des informations supplémentaires, le masquage des données sensibles auprès des utilisateurs externes, la vérification du contenu des messages pour détecter les menaces potentielles, la mise en cache des réponses courantes pour améliorer les performances, etc. Les règles peuvent être exécutées de manière conditionnelle en fonction du contenu ou du contexte d'un message de requête ou de réponse. Par exemple, une règle de transformation peut être exécutée pour personnaliser un format de réponse si le message de la requête a été envoyé depuis un smartphone.
- développeur post-payé
- Développeur facturé mensuellement pour l'utilisation des produits d'API. Le développeur paie pour l'utilisation des produits d'API en fonction des conditions de paiement définies par les plans tarifaires. Les développeurs se voient attribuer l'état post-payé, ou prépayé, par le fournisseur d'API.
- proxy
- Également appelé proxy d'API. Un proxy d'API constitue une couche d'abstraction qui s'intercale devant les API de votre service de backend et leur procure des fonctionnalités à valeur ajoutée, telles que la sécurité, la limitation du débit, les quotas, les analyses, etc.
- point de terminaison de proxy
- Un point de terminaison de proxy définit la manière dont votre proxy d'API interagit avec les applications clientes. Vous configurez le point de terminaison du proxy avec un chemin de base qui fait partie de l'URL à laquelle votre proxy d'API répond.
L'URL se présente sous la forme suivante :
https://hostname/basepath/pathsuffixes. Consultez la page Créer un proxy d'API.
R
- plan tarifaire
- Spécification des frais et du partage des revenus pour l'utilisation des produits d'API proposés dans un package d'API monétisé.
- contrôleur de réplication
- Reprogramme les pods et gère leur autoréparation.
- ressource, chemin d'accès à la ressource
- Concept RESTful, un identifiant de ressource uniforme (URI) qui identifie le chemin d'accès réseau à une ressource donnée.
- révisions
- Package de configuration et de règles regroupées dans un proxy d'API, numéroté et contrôlé par une version. Ce terme diffère de version, qui est l'interface de l'API destinée aux développeurs. Voir "version" ci-dessous.
- plan d'exécution
Les services d'Apigee hybride que vous gérez sur votre propre cluster Kubernetes existent dans le plan d'exécution. Ces services communiquent via les comptes de service avec le plan de gestion.
Inclut MART, le synchronisateur, les processeurs de messages, Cassandra et d'autres composants.
Pour en savoir plus, consultez la section À propos du plan d'exécution.
- instance d'exécution
- Apigee peut être configuré avec plusieurs instances d'exécution, une par région géographique. Un ou plusieurs environnements peuvent être associés à une instance d'exécution, ce qui offre une haute disponibilité aux proxys d'API répartis sur plusieurs régions.
- service
Terme générique désignant les applications en conteneur exécutées sur votre cluster Kubernetes dans le plan d'exécution. Ces services incluent MART, le synchronisateur, les processeurs de messages et Cassandra.
Pour en savoir plus, consultez la section À propos du plan d'exécution.
- nœud avec état
- Nœud de cluster nécessitant un stockage persistant pour conserver l'état. Consultez la page Configurer des pools de nœuds dédiés.
- nœud sans état
- Nœud de cluster qui ne nécessite pas de stockage persistant. Consultez la page Configurer des pools de nœuds dédiés.
- Synchronisateur
Service de plan d'exécution qui interroge le plan de gestion pour rechercher la configuration de déploiement et les événements de chaque environnement. Il télécharge les métadonnées requises sur les proxys déployés, les fichiers de configuration du proxy, et autres, dans le plan d'exécution.
Le synchronisateur stocke ses informations dans un système de fichiers partagé lu par le processeur de messages. Cette opération s'exécute en tant qu'application DaemonSet. Elle ne génère pas de trafic d'API d'exécution et peut synchroniser les données de plusieurs environnements à partir d'un seul processus/pod Kubernetes.
Pour en savoir plus, consultez la section À propos du plan d'exécution.
- point de terminaison cible
Un point de terminaison cible définit la manière dont votre proxy d'API interagit avec vos services de backend. Vous configurez le point de terminaison cible pour qu'il transfère les requêtes vers le service de backend approprié, ce qui suppose de définir les paramètres de sécurité, le protocole HTTP ou HTTPS et d'autres informations de connexion. Consultez la section Modifier le point de terminaison cible.
- crédit
- Action effectuée par un développeur pour ajouter des fonds à sa réserve prépayée.
- transaction_success_def" id="transaction_success_def">réussite de transaction
- variable de monétisation qui, lorsqu'elle est utilisée, indique si une transaction d'API est monétisée ou non. Cette variable peut être utilisée pour remplacer le comportement par défaut, basé sur le code d'état HTTP. Consultez la section Variables de monétisation.
- UAP
Unified Analytics Platform (plate-forme d'analyse unifiée). Service Apigee du plan de gestion qui traite les données d'analyse, de débogage et d'état de déploiement entrantes et les met à votre disposition via l'interface utilisateur hybride Apigee ou les API Apigee.
Pour en savoir plus, consultez la page Collecte de données de débogage, d'analyse et d'état du déploiement.
- UDCA
Agent de collecte de données universel. Service exécuté dans le pod de collecte de données du plan d'exécution, qui extrait les données d'analyse, de débogage et d'état de déploiement et les envoie à l'UAP.
Pour en savoir plus, consultez la page Collecte de données de débogage, d'analyse et d'état du déploiement.
- version
- Version de l'interface de l'API destinée aux développeurs. Par exemple,
pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. Ce terme diffère derevision, qui correspond au package de configuration et de règles regroupées dans un proxy d'API, numéroté et contrôlé par la version. En résumé, les versions s'appliquent aux interfaces d'API et les révisions aux proxys d'API. - volume
- Espace de stockage partagé pouvant être utilisé par toutes les applications conteneurisées d'un pod.