Premiers pas avec Apigee à l'aide de gcloud

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

La CLI gcloud apigee vous permet d'effectuer les opérations suivantes :

  • Afficher les proxys d'API
  • Créer et gérer des produits d'API
  • Déployer et annuler le déploiement des proxys d'API et afficher les détails du déploiement
  • Afficher des informations sur les développeurs et les applications
  • Répertorier vos environnements et organisations
  • Gérer les applications tierces qui appellent des proxys d'API Apigee

De plus, la CLI gcloud beta apigee vous permet de déployer et de gérer des archives dans votre environnement Apigee.

Les sections suivantes décrivent comment installer, autoriser et utiliser les CLI gcloud apigee et gcloud beta apigee, et éventuellement définir des variables d'environnement.

Avant de commencer

Vérifiez que vous remplissez les conditions préalables d'utilisation d'Apigee, y compris l'installation du SDK Google Cloud.

Installer les composants gcloud beta apigee

Pour accéder aux commandes gcloud beta apigee, vous devez installer le composant gcloud beta complet, comme suit :

gcloud components install beta

Pour vérifier que le composant bêta a bien été installé, saisissez la commande suivante :

gcloud components list

Vous devriez voir le composant bêta dans la liste, comme suit :

État Nom ID Taille
Installé Commandes gcloud bêta bêta < 1 Mio

Pour en savoir plus, consultez la section Gérer les composants du SDK.

Autoriser l'accès à gcloud

Autorisez l'accès à la CLI gloud en suivant les étapes décrites sur la page Autoriser les outils du SDK Cloud.

Par exemple, pour autoriser l'accès à l'aide de votre compte utilisateur et effectuer d'autres étapes courantes de configuration du SDK Cloud, utilisez la commande suivante :

gcloud init

Suivez les instructions pour authentifier le compte, accorder des autorisations d'accès et initialiser l'installation du SDK Cloud, comme décrit dans la section Initialiser le SDK Cloud.

Pour autoriser l'accès sans aucune configuration supplémentaire, vous pouvez également utiliser la commande suivante :

gcloud auth login

Suivez le flux d'autorisation basé sur le navigateur pour authentifier le compte et accorder les autorisations d'accès.

Pour en savoir plus sur l'autorisation et la révocation de l'accès à la CLI gcloud, consultez la section Identifiants.

Définir des variables d'environnement pour les commandes gcloud

Les exemples d'API Apigee et de CLI gcloud fournis dans la documentation utilisent une ou plusieurs des variables d'environnement définies dans le tableau suivant.

En définissant les variables d'environnement à l'avance sur des valeurs significatives dans votre environnement, vous pouvez copier et coller les exemples de requêtes afin de les exécuter dans votre propre environnement sans les modifier, ou très peu.

Variable d'environnement Description
$API Nom du proxy de votre API
$APIPRODUCT Nom du produit d'API
$APP ID d'une application
$DEVELOPER_EMAIL Adresse e-mail du développeur
$ENV Nom de votre environnement, tel que test ou prod
$ID ID de ressource
$KEY Clé client.
$NAME Nom de votre ressource
$ORG Votre organisation Apigee
$REV Numéro de révision de votre proxy d'API
$SHAREDFLOW Nom de votre flux partagé
$TYPE Type de ressource.

Utiliser la CLI gcloud

Utilisez la CLI gcloud comme suit :

gcloud apigee GROUP [GCLOUD_WIDE_FLAG …]

Pour en savoir plus sur les options et les groupes de commandes disponibles, consultez la page gcloud apigee.

Par exemple, la commande suivante répertorie les proxys d'API de votre organisation :

gcloud apigee apis list --organization=$ORG

Vous trouverez ci-dessous un exemple de réponse pour l'organisation my-org :

Using Apigee organization `myorg`
 - hello-world
 - weather-app
 

En savoir plus

Pour en savoir plus, consultez les pages suivantes :