Teilen über

Referenz: Schema von Gatewayprotokollen

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Dieser Artikel enthält eine Schemareferenz für das GatewayLogs-Ressourcenprotokoll von Azure API Management. Protokolleinträge beinhalten auch Felder im allgemeinen Schema der obersten Ebene.

Informationen zum Aktivieren der Sammlung des Ressourcenprotokolls in API Management finden Sie unter Überwachen von veröffentlichten APIs.

GatewayLogs-Schema

Die folgenden Eigenschaften werden für jede API-Anforderung protokolliert:

Eigenschaft Typ Beschreibung
ApiId Zeichenfolge API-Entitätsbezeichner für die aktuelle Anforderung
ApimSubscriptionId Zeichenfolge Abonnemententitätsbezeichner für die aktuelle Anforderung
ApiRevision Zeichenfolge API-Revision für die aktuelle Anforderung
BackendId Zeichenfolge Back-End-Entitätsbezeichner für die aktuelle Anforderung
BackendMethod Zeichenfolge HTTP-Methode der an ein Back-End gesendeten Anforderung
BackendProtocol Zeichenfolge HTTP-Protokollversion der an ein Back-End gesendeten Anforderung
BackendRequestBody Zeichenfolge Back-End-Anforderungstext
BackendRequestHeaders dynamisch Sammlung von HTTP-Headern, die an ein Back-End gesendet werden
BackendResponseBody Zeichenfolge Back-End-Antworttext
BackendResponseCode INT Code der von einem Back-End empfangenen HTTP-Antwort
BackendResponseHeaders dynamisch Sammlung von HTTP-Headern, die von einem Back-End empfangen werden
BackendTime long Anzahl von Millisekunden für alle Back-End-E/A-Vorgänge (Verbindungsherstellung sowie Senden und Empfangen von Bytes)
BackendUrl Zeichenfolge URL der an ein Back-End gesendeten Anforderung
Cache Zeichenfolge Status der API Management-Cachenutzung bei der Anforderungsverarbeitung (Treffer, Fehler, Keiner)
CacheTime long Anzahl von Millisekunden für alle API Management-Cache-E/A-Vorgänge (Verbindungsherstellung, Senden und Empfangen von Bytes)
ClientProtocol Zeichenfolge HTTP-Protokollversion der eingehenden Anforderung
ClientTime long Anzahl von Millisekunden für alle Client-E/A-Vorgänge (Verbindungsherstellung sowie Senden und Empfangen von Bytes)
ClientTlsVersion Zeichenfolge Verwendete TLS-Version des Clients, der die Anforderung sendet
Fehler dynamisch Sammlung von Fehlern, die während der Anforderungsverarbeitung aufgetreten sind
IsRequestSuccess bool HTTP-Anforderung mit einem Antwortstatuscode im Bereich 2xx oder 3xx abgeschlossen
LastErrorElapsed long Anzahl der Millisekunden, die zwischen dem Eingehen der Anforderung beim Gateway und dem Auftreten des Fehlers vergangen sind
LastErrorMessage Zeichenfolge Fehlermeldung
LastErrorReason Zeichenfolge Fehlerursache
LastErrorScope Zeichenfolge Der Fehler wurde durch den Bereich des Richtliniendokuments verursacht, das die Richtlinie enthält.
LastErrorSection Zeichenfolge Der Fehler wurde durch den Abschnitt des Richtliniendokuments verursacht, das die Richtlinie enthält.
LastErrorSource Zeichenfolge Der Fehler wurde durch den Namen der Richtlinie oder die Verarbeitung des internen Handlers verursacht.
Methode Zeichenfolge HTTP-Methode der eingehenden Anforderung
OperationId Zeichenfolge Vorgangsentitätsbezeichner für die aktuelle Anforderung
ProductId Zeichenfolge Produktentitätsbezeichner für die aktuelle Anforderung
RequestBody Zeichenfolge Clientanforderungstext
RequestHeaders dynamisch Sammlung von HTTP-Headern, die von einem Client gesendet werden
RequestSize INT Anzahl der Bytes, die von einem Client während der Anforderungsverarbeitung empfangen werden
ResponseBody Zeichenfolge Gatewayantworttext
ResponseCode INT Statuscode der an einen Client gesendeten HTTP-Antwort
ResponseHeaders dynamisch Sammlung von HTTP-Headern, die an einen Client gesendet werden
ResponseSize INT Anzahl der Bytes, die während der Anforderungsverarbeitung an einen Client gesendet werden
TotalTime long Anzahl von Millisekunden für die gesamte HTTP-Anforderung (vom ersten von API Management empfangenen Byte bis zum letzten von einem Client empfangenen Byte)
TraceRecords dynamisch Von Ablaufverfolgungsrichtlinien ausgegebene Datensätze
url Zeichenfolge URL der eingehenden Anforderung
UserId Zeichenfolge Benutzerentitätsbezeichner für die aktuelle Anforderung

Nächste Schritte