Objectif

Une fois qu'une API a été créée, vous pourrez accéder à son interface de gestion. L'onglet Overview vous permet de gérer facilement l'ensemble du cycle de vie de votre API.

L'écran est divisé en 3 parties :

• Le bloc du haut (vert) affiche des indicateurs relatifs aux ressources utilisées par l'API. Ces indicateurs permettent par exemple de savoir s'il est nécessaire d'augmenter le nombre d'instances.

• Le bloc de gauche (jaune) indique le statut de la version active (en production). Certains raccourcis sont proposés sous forme de boutons selon l'état (New / Built / Deployed) de la version.

• Le bloc de droite (bleu) liste les différentes versions de l'API. La version active est affichée en bleu. Différentes actions sont possibles pour chaque version :

  • Synchroniser / télécharger - action dépendant du type de source du code (fichier ZIP ou dépôt GIT)
  • Dupliquer la version
  • Construire l'artefact de cette version
  • Déployer / arrêter la version
  • Ouvrir la console de construction
  • Supprimer la version - nécessite que la version n'ait pas été déployée

Configuration des extensions

Lors de la création d'une API via le Marketplace, celle-ci est créée avec un ensemble d'extensions par défaut qui peuvent être visualisées dans l'onglet Extensions.

Voir la liste des extensions

Cet écran permet de visualiser les différentes bibliothèques organisées par catégories avec la possibilité de :

• Supprimer les extensions déjà installées
• Ajouter de nouvelles extensions non encore installées sur l'API
• Configurer le package d'une extension
• Accéder à des informations complémentaires sur les bibliothèques
• Importer une extension open source ou propriétaire, spécifique à un projet ou à une organisation

Paramètres

Trois types de paramètres d'API sont configurables dans l'onglet Settings.

• Global : fait référence aux informations globales de l'API telles que son nom, sa description et son image principale.

• Environment Variables : définit les variables dont l'API a besoin pour fonctionner. Celles nécessaires au bon fonctionnement de l'API et de ses différentes extensions sont renseignées automatiquement. Seules les variables spécifiques à un besoin métier sont présentées ici.

• Domain Name System : vous permet d'ajouter une ou plusieurs URL permettant d'accéder à l'API, en plus de celle générée par défaut. Ces URL ont pour domaine « eu.dataplatform.ovh.net » à moins que vous n'ayez ajouté un autre domaine au niveau de l'organisation.

Aller plus loin

Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur ce lien pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services.

Posez vos questions, faites-nous part de vos commentaires et interagissez directement avec l’équipe qui développe la Data Platform sur le canal Discord dédié.

Si vous avez besoin d'une assistance concernant vos services OVHcloud, créez une demande depuis notre centre d'aide.

Rejoignez notre communauté d'utilisateurs.