Referens: API Management resursloggschema
Den här artikeln innehåller en schemareferens för resursloggen Azure API Management GatewayLogs. Loggposter innehåller även fält i det gemensamma schemat på den översta nivån.
Information om hur du aktiverar insamling av resursloggen i API Management finns i Övervaka publicerade API:er.
GatewayLogs-schema
Följande egenskaper loggas för varje API-begäran.
| Egenskap | Typ | Description |
|---|---|---|
| ApiId | sträng | API-entitetsidentifierare för aktuell begäran |
| ApimSubscriptionId | sträng | Prenumerationsentitetsidentifierare för aktuell begäran |
| ApiRevision | sträng | API-revision för aktuell begäran |
| BackendId | sträng | Serverdelentitetsidentifierare för aktuell begäran |
| BackendMethod | sträng | HTTP-metod för begäran som skickats till en serverdel |
| BackendProtocol | sträng | HTTP-protokollversion för begäran som skickats till en serverdel |
| BackendRequestBody | sträng | Brödtext för serverdelsbegäran |
| BackendRequestHeaders | dynamisk | Samling HTTP-huvuden som skickats till en serverdel |
| BackendResponseBody | sträng | Serverdelens svarstext |
| BackendResponseCode | int | Kod för HTTP-svaret togs emot av en serverdel |
| BackendResponseHeaders | dynamisk | Samling HTTP-huvuden som tagits emot från en serverdel |
| BackendTime | long | Antal millisekunder som spenderas på övergripande serverdels-I/O (ansluta, skicka och ta emot byte) |
| BackendUrl | sträng | URL för begäran som skickats till en serverdel |
| Cache | sträng | Status för API Management cachens inblandning i bearbetning av begäranden (träff, miss, ingen) |
| CacheTime | long | Antal millisekunder som spenderats på övergripande API Management cache-I/O (ansluta, skicka och ta emot byte) |
| ClientProtocol | sträng | HTTP-protokollversion för inkommande begäran |
| ClientTime | long | Antal millisekunder som spenderats på övergripande klient-I/O (ansluta, skicka och ta emot byte) |
| ClientTlsVersion | sträng | TLS-version som används av klienten som skickar begäran |
| Fel | dynamisk | Insamling av fel uppstod under bearbetning av begäran |
| IsRequestSuccess | boolesk | HTTP-begäran slutfördes med svarsstatuskod inom intervallet 2xx eller 3xx |
| LastErrorElapsed | long | Antal millisekunder som förflutit sedan gatewayen tog emot begäran tills felet inträffade |
| LastErrorMessage | sträng | Felmeddelande |
| LastErrorReason | sträng | Felorsak |
| LastErrorScope | sträng | Omfånget för principdokumentet som innehåller principen orsakade felet |
| LastErrorSection | sträng | Avsnittet i principdokumentet som innehåller principen orsakade felet |
| LastErrorSource | sträng | Namngivning av principen eller den interna hanteraren för bearbetning orsakade felet |
| Metod | sträng | HTTP-metod för inkommande begäran |
| OperationId | sträng | Åtgärdsentitetsidentifierare för aktuell begäran |
| ProductId | sträng | Produktentitetsidentifierare för aktuell begäran |
| RequestBody | sträng | Brödtext för klientbegäran |
| RequestHeaders | dynamisk | Samling HTTP-huvuden som skickas av en klient |
| RequestSize | int | Antalet byte som tagits emot från en klient under bearbetning av begäran |
| ResponseBody | sträng | Gateway-svarstext |
| ResponseCode | int | Statuskod för HTTP-svar som skickas till klient |
| ResponseHeaders | dynamisk | Samling HTTP-huvuden som skickas till en klient |
| ResponseSize | int | Antalet byte som har skickats till en klient under bearbetning av begäran |
| TotalTime | long | Antal millisekunder som spenderats på övergripande HTTP-begäran (från första byte som tagits emot av API Management till senaste byte som en klient tog emot tillbaka) |
| TraceRecords | dynamisk | Poster som genereras av spårningsprinciper |
| URL | sträng | URL för inkommande begäran |
| UserId | sträng | Användarentitetsidentifierare för aktuell begäran |
Nästa steg
- Information om hur du övervakar API:er i API Management finns i Övervaka publicerade API:er
- Läs mer om vanliga och tjänstspecifika scheman för Azure-resursloggar