Utiliser l'API Monitoring Management

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Utilisez l'API de gestion API Monitoring pour effectuer les tâches suivantes.

Tâche En savoir plus
Gérer les alertes pour la surveillance des API
Gérer les collections pour la surveillance des API
Afficher les journaux de surveillance des API à différents niveaux
Afficher les métriques de surveillance des API

Quotas des appels d'API

Toutes les API de surveillance des API appliquent un quota du nombre d'appels d'API par minute. Par exemple, l'API Create Collections vous limite à six appels par minute.

Toutes les API ne sont pas soumises aux mêmes quotas. Pour connaître les quotas d'une API, consultez sa documentation de référence.

Utiliser curl

Les exemples d'API figurant dans ce document utilisent curl pour montrer le fonctionnement de la surveillance des API à l'aide de l'API. curl est un outil de ligne de commande Open Source permettant de transférer des données avec une syntaxe d'URL compatible avec les protocoles courants tels que HTTP et HTTPS. Pour en savoir plus sur le téléchargement et l'utilisation de curl, consultez la page https://curl.haxx.se/.

Le tableau suivant récapitule les options de ligne de commande curl utilisées dans les exemples.

Option Description
-d '{}'

--data @filename

Définit le corps de la requête, transmise directement ou en spécifiant un nom de fichier.
-H

--header

Définit un en-tête de requête. Vous devez transmettre les informations suivantes dans l'en-tête de requête :
  • Jeton OAuth 2.0 pour l'authentification de l'utilisateur à l'aide de l'en-tête Authorization, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0.
  • Types de contenu pris en charge par le client à l'aide de l'en-tête Accept.
  • Type de contenu du corps de requête envoyé lors de la création ou de la mise à jour d'une ressource (POST, PATCH, PUT) à l'aide de l'en-tête Content-Type.
-i Affiche plus d'informations, telles que les en-têtes, dans la réponse.
-X Spécifie le type de demande (GET, POST, etc.).

Obtenir un jeton d'accès OAuth 2.0

Apigee Edge est compatible avec OAuth 2.0 pour l'authentification des utilisateurs. Avec OAuth 2.0, vous échangez vos identifiants Apigee Edge contre un jeton d'accès et un jeton d'actualisation que vous pouvez ensuite utiliser pour effectuer des appels sécurisés à l'API Apigee Edge. Une fois que vous avez obtenu un jeton, vous n'avez pas besoin d'échanger vos identifiants jusqu'à son expiration. Le jeton d'actualisation vous permet de conserver votre "session" avec le serveur pendant une période plus longue sans spécifier vos identifiants. Pour en savoir plus sur les jetons d'accès, consultez Utiliser OAuth2 pour accéder à l'API de gestion.

À l'aide de vos identifiants Apigee Edge, vous pouvez obtenir un accès OAuth 2.0 et des jetons d'actualisation pour accéder aux ressources Apigee Edge à l'aide de l'utilitaire get_token d'Apigee.

Pour obtenir un jeton d'accès OAuth 2.0, procédez comme suit :

  1. Installez l'utilitaire get_token. Pour plus d'informations sur l'installation de l'utilitaire get_token, consultez la page Utiliser get_token.

  2. Exécutez get_token pour obtenir un jeton d'accès OAuth 2.0.

    La première fois que vous saisissez la commande ou en cas d'expiration du jeton d'actualisation, get_token vous invite à spécifier votre nom d'utilisateur, votre mot de passe et le code d'authentification à deux facteurs comportant six chiffres. Saisissez chaque valeur lorsque vous y êtes invité. Si l'authentification à deux facteurs n'est pas activée, appuyez simplement sur Entrée lorsque l'invite s'affiche.

  3. Copiez le jeton OAuth 2.0 et stockez-le dans une variable, telle que ACCESS_TOKEN :

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Lorsque vous appelez l'API Monitoring des API, transmettez le jeton d'accès OAuth 2.0 dans l'en-tête HTTP à l'aide de l'en-tête Authorization. Exemple :


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...