Referência: Esquema de log do gateway
APLICA-SE A: Todas as camadas de gerenciamento de API
Este artigo fornece uma referência de esquema para o log de recursos do Azure API Management GatewayLogs. As entradas de log também incluem campos no esquema comum de nível superior.
Para habilitar a coleta do log de recursos no Gerenciamento de API, consulte Monitorar APIs publicadas.
Esquema GatewayLogs
As propriedades a seguir são registradas para cada solicitação de API.
Propriedade | Type | Description |
---|---|---|
ApiId | string | Identificador da entidade de API do pedido atual |
ApimSubscriptionId | string | Identificador da entidade de subscrição do pedido atual |
ApiRevision | string | Revisão da API para solicitação atual |
BackendId | string | Identificador da entidade de back-end do pedido atual |
Método de Backend | string | Método HTTP do pedido enviado para um back-end |
Protocolo de Back-End | string | Versão do protocolo HTTP do pedido enviado para um back-end |
BackendRequestBody | string | Corpo da solicitação de back-end |
BackendRequestHeaders | dynamic | Coleção de cabeçalhos HTTP enviados para um back-end |
BackendResponseBody | string | Corpo de resposta de back-end |
BackendResponseCode | número inteiro | Código da resposta HTTP recebido a partir de um back-end |
BackendResponseHeaders | dynamic | Coleção de cabeçalhos HTTP recebidos de um back-end |
BackendTime | long | Número de milissegundos gastos em E/S de back-end geral (conexão, envio e recebimento de bytes) |
BackendUrl | string | URLdo pedido enviado para um back-end |
Cache | string | Status do envolvimento do cache de Gerenciamento de API no processamento de solicitações (acerto, erro, nenhum) |
CacheTime | long | Número de milissegundos gastos na E/S geral do cache de Gerenciamento de API (conectando, enviando e recebendo bytes) |
Protocolo Cliente | string | Versão do protocolo HTTP do pedido a receber |
ClientTime | long | Número de milissegundos gastos na E/S geral do cliente (conexão, envio e recebimento de bytes) |
ClientTlsVersion | string | Versão TLS usada pelo cliente enviando solicitação |
Erros | dynamic | Ocorreu a recolha de erros durante o processamento do pedido |
IsRequestSuccess | booleano | Solicitação HTTP concluída com código de status de resposta dentro do intervalo 2xx ou 3xx |
LastErrorElapsed | long | Número de milissegundos decorridos desde que o gateway recebeu a solicitação até que o erro ocorresse |
LastErrorMessage | string | Mensagem de Erro |
LastErrorReason | string | Motivo do erro |
LastErrorScope | string | O escopo do documento de política que contém a política causou o erro |
LastErrorSection | string | A seção do documento de política que contém a política causou o erro |
LastErrorSource | string | A nomeação da política ou o processamento do manipulador interno causou o erro |
Método | string | Método HTTP do pedido a receber |
OperationId | string | Identificador da entidade de operação do pedido atual |
ProductId | string | Identificador da entidade de produto do pedido atual |
RequestBody | string | Corpo do pedido do cliente |
RequestHeaders | dynamic | Coleção de cabeçalhos HTTP enviados por um cliente |
RequestSize | número inteiro | Número de bytes recebidos de um cliente durante o processamento do pedido |
ResponseBody | string | Corpo de resposta do gateway |
Código de resposta | número inteiro | Código de estado da resposta HTTP enviada para um cliente |
ResponseHeaders | dynamic | Coleção de cabeçalhos HTTP enviados a um cliente |
ResponseSize | número inteiro | Número de bytes enviados para um cliente durante o processamento do pedido |
TotalTime | long | Número de milissegundos gastos na solicitação HTTP geral (do primeiro byte recebido pelo Gerenciamento de API até o último byte que um cliente recebeu de volta) |
TraceRecords | dynamic | Registros emitidos por políticas de rastreamento |
Url | string | URL do pedido a receber |
UserId | string | Identificador da entidade de utilizador do pedido atual |
Próximos passos
- Para obter informações sobre como monitorar APIs no Gerenciamento de APIs, consulte Monitorar APIs publicadas
- Saiba mais sobre o esquema comum e específico do serviço para Logs de Recursos do Azure
- Referência do esquema DeveloperPortalAuditLogs