Informations de référence : schéma du journal de la passerelle
S’APPLIQUE À : Tous les niveaux de Gestion des API
Cet article fournit des informations de référence de schéma pour le journal de ressource GatewayLogs de Gestion des API Azure. Les entrées de journal incluent également des champs dans le schéma commun de niveau supérieur.
Pour activer la collecte du journal de ressource dans Gestion des API, consultez Surveiller les API publiées.
Schéma GatewayLogs
Les propriétés suivantes sont journalisées pour chaque demande d’API.
Propriété | Type | Description |
---|---|---|
ApiId | string | Identificateur d’entité d’API pour la requête actuelle |
ApimSubscriptionId | string | Identificateur d’entité d’abonnement pour la requête actuelle |
ApiRevision | string | Révision d’API pour la demande actuelle |
BackendId | string | Identificateur d’entité de serveur principal pour la requête actuelle |
BackendMethod | string | Méthode HTTP de la requête envoyée à un serveur principal |
BackendProtocol | string | Version du protocole HTTP de la requête envoyée à un service principal |
BackendRequestBody | string | Corps de la demande du serveur principal |
BackendRequestHeaders | dynamique | Collection d’en-têtes HTTP envoyés à un serveur principal |
BackendResponseBody | string | Corps de la réponse du serveur principal |
BackendResponseCode | int | Code de la réponse HTTP reçue d’un serveur principal |
BackendResponseHeaders | dynamique | Collection d’en-têtes HTTP reçues d’un serveur principal |
BackendTime | long | Nombre de millisecondes consacrées à l’ensemble des E/S du serveur principal (connexion, envoi et réception d’octets) |
BackendUrl | string | URL de la requête envoyée à un serveur principal |
Cache | string | État d’implication du cache du service Gestion des API dans le traitement des requêtes (atteint, manqué, aucun) |
CacheTime | long | Nombre de millisecondes consacrées à l’ensemble des E/S du cache du service Gestion des API (connexion, envoi et réception d’octets) |
ClientProtocol | string | Version du protocole HTTP de la requête entrante |
ClientTime | long | Nombre de millisecondes consacrées à l’ensemble des E/S du client (connexion, envoi et réception d’octets) |
ClientTlsVersion | string | Version TLS utilisée par le client qui envoie la demande |
Erreurs | dynamique | Collection des erreurs qui se sont produits pendant le traitement des requêtes |
IsRequestSuccess | bool | La requête HTTP s’est terminé avec un code d’état de réponse dans la plage 2xx ou 3xx |
LastErrorElapsed | long | Nombre de millisecondes écoulées entre le moment où la passerelle a reçu la requête et celui où l’erreur s’est produite |
LastErrorMessage | string | Message d’erreur |
LastErrorReason | string | Motif de l’erreur |
LastErrorScope | string | Étendue du document contenant la stratégie qui a provoqué l’erreur |
LastErrorSection | string | Section du document contenant la stratégie qui a provoqué l’erreur |
LastErrorSource | string | Nom de la stratégie ou du gestionnaire interne de traitement qui a provoqué l’erreur |
Méthode | string | Méthode HTTP de la requête entrante |
OperationId | string | Identificateur d’entité d’opération pour la requête actuelle |
ProductId | string | Identificateur d’entité de produit pour la requête actuelle |
RequestBody | string | Corps de la demande client |
RequestHeaders | dynamique | Collection d’en-têtes HTTP envoyés par un client |
RequestSize | int | Nombre d’octets reçus d’un client au cours du traitement de la requête |
ResponseBody | string | Corps de la réponse de la passerelle |
ResponseCode | int | Code d’état de la réponse HTTP envoyée à un client |
ResponseHeaders | dynamique | Collection d’en-têtes HTTP envoyés à un client |
ResponseSize | int | Nombre d’octets envoyés à un client au cours du traitement de la requête |
temps_total | long | Nombre de millisecondes passées sur l’ensemble de la requête HTTP (du premier octet reçu par Gestion des API au dernier octet reçu par un client) |
TraceRecords | dynamique | Enregistrements émis par les stratégies de trace |
Url | string | URL de la requête entrante |
UserId | string | Identificateur d’entité d’utilisateur pour la requête actuelle |
Étapes suivantes
- Pour plus d’informations sur la supervision des API dans Gestion des API, consultez Surveiller les API publiées.
- Découvrez en plus sur les schémas communs et spécifiques de services pour les journaux de ressources Azure.
- Informations de référence de schéma DeveloperPortalAuditLogs