Afficher les journaux à l'aide de l'API

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Téléchargez les journaux d'API Monitoring pour afficher les données brutes utilisées pour calculer les métriques affichées dans les tableaux de bord d'API Monitoring. Vous pouvez télécharger des journaux pour des plages de temps personnalisées, des proxys spécifiques, des codes d'état spécifiques et de nombreuses autres variables.

Remarque : Par défaut, les appels à l'API Logs ne renvoient que les résultats avec les codes d'état 4xx et 5xx, mais pas avec le code 2xx. Cela permet de limiter le nombre de résultats, car la plupart d'entre eux ont le code d'état 2xx. Pour obtenir des résultats avec le code d'état 2xx, ajoutez status=2xx à la requête. Exemple : https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

Les sections suivantes décrivent comment gérer les journaux à l'aide de l'API :

Pour en savoir plus sur l'API Logs, consultez la section API Logs.

Pour en savoir plus sur les options cURL utilisées dans ces exemples, consultez la section Utiliser cURL.

Télécharger les journaux d'une organisation et d'un environnement

Téléchargez les journaux d'une organisation et d'un environnement spécifiques à l'aide de l'API Logs :

https://apimonitoring.enterprise.apigee.com/logs

Vous devez transmettre le nom de l'organisation et de l'environnement à l'aide des paramètres de requête org et env.

Par défaut, l'API renvoie les 10 entrées de journal les plus récentes pour l'heure précédente. Exemple :

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Définissez $ACCESS_TOKEN sur votre jeton d'accès OAuth 2.0, comme décrit dans Obtenir un jeton d'accès OAuth 2.0.

La réponse est un tableau d'entrées de journal au format suivant :

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

Utilisez les paramètres de requête from et to pour spécifier une plage de temps au format ISO. Le format de date peut être l'un des suivants :

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

Exemple :

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

L'API comporte de nombreux paramètres de requête facultatifs. Par exemple, pour afficher les journaux d'un proxy nommé myAPI générant des réponses HTTP 404 :

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Pour renvoyer plus de 10 entrées de journal, définissez le paramètre de requête limit. Vous pouvez le définir sur une valeur maximale de 1 000 :

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Pour obtenir d'autres options, consultez la section API Logs.

Lister les proxys associés à un hôte virtuel et à un chemin de base

Un hôte virtuel sur un routeur Edge vous permet de spécifier un nom de domaine, un protocole tel que HTTP/HTTPS et un numéro de port. Par exemple, vous définissez un hôte virtuel sur un routeur Edge avec les paramètres suivants :

  • Alias d'hôte = apis.acme.com
  • Port = 443
  • TLS activé

En fonction de ces paramètres, une requête adressée à un proxy d'API associé à cet hôte virtuel utilise le format suivant :

https://apis.acme.com/proxy-base-path/resource-path

Où :

  • proxy-base-path est défini lorsque vous créez un proxy d'API et est unique pour chaque proxy d'API.
  • resource-path est le chemin d'accès à une ressource accessible via le proxy d'API.

Pour plus d'informations sur les hôtes virtuels, voir À propos des hôtes virtuels.

Téléchargez la liste des proxys d'API associés à un hôte virtuel et à un chemin de base spécifiques en envoyant une requête GET à la ressource suivante de l'API Logs :

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

Vous devez transmettre le nom de l'organisation et de l'environnement à l'aide des paramètres de requête org et env, ainsi que l'URI associé à l'hôte virtuel et au chemin de base.

Par exemple, l'appel d'API suivant renvoie les proxys associés à l'hôte virtuel http://apis.acme.com et à un chemin de base /v1/perf :

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Définissez $ACCESS_TOKEN sur votre jeton d'accès OAuth 2.0, comme décrit dans Obtenir un jeton d'accès OAuth 2.0.

Pour obtenir d'autres options, consultez la section API Logs.