Personalizzazione dei registri di HTTP API accesso - Amazon API Gateway

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Personalizzazione dei registri di HTTP API accesso

È possibile utilizzare le seguenti variabili per personalizzare i registri di HTTP API accesso. Per ulteriori informazioni sui log di accesso per HTTPAPIs, consulta. Configurare la registrazione per le API HTTP in API Gateway

Parametro Descrizione
$context.accountId

L'ID dell' AWS account del API proprietario.
$context.apiId

L'identificatore che API Gateway assegna al tuo. API
$context.authorizer.claims.property

Una proprietà delle affermazioni restituite dal JSON Web Token (JWT) dopo che il chiamante del metodo è stato autenticato con successo, ad esempio. $context.authorizer.claims.username Per ulteriori informazioni, consulta Controlla l'accesso HTTP APIs con gli JWT autorizzatori in API Gateway.

Nota

La chiamata di $context.authorizer.claims restituisce null.
$context.authorizer.error Il messaggio di errore restituito da un'autorizzazione.
$context.authorizer.principalId

Identificazione dell'utente principale restituita da un provider di autorizzazioni Lambda.
$context.authorizer.property

Il valore della coppia chiave-valore specificata della context mappa restituita da una funzione di autorizzazione Gateway API Lambda. Ad esempio, se le autorizzazioni restituiscono la mappa context seguente: 

"context" : {
  "key": "value",
  "numKey": 1,
  "boolKey": true
}

chiamando $context.authorizer.key viene restituita la stringa "value", chiamando $context.authorizer.numKey viene restituito 1 e chiamando $context.authorizer.boolKey viene restituito true.
$context.awsEndpointRequestId

L'ID della richiesta dell' AWS endpoint dall'intestazione or. x-amz-request-id x-amzn-requestId
$context.awsEndpointRequestId2

L'ID della richiesta dell' AWS endpoint dall'intestazione. x-amz-id-2
$context.customDomain.basePathMatched

Il percorso di una API mappatura a cui corrisponde una richiesta in arrivo. Applicabile quando un client utilizza un nome di dominio personalizzato per accedere a un. API Ad esempio, se un client invia una richiesta ahttps://api.example.com/v1/orders/1234, e la richiesta corrisponde alla API mappatura con il percorsov1/orders, il valore èv1/orders. Per ulteriori informazioni, consulta Mappa API le fasi su un nome di dominio personalizzato per HTTP APIs.
$context.dataProcessed La quantità di dati elaborati in byte.
$context.domainName

Il nome di dominio completo utilizzato per richiamare il. API Deve essere lo stesso dell'intestazione Host in ingresso.
$context.domainPrefix

Prima etichetta di $context.domainName.
$context.error.message

Una stringa che contiene un messaggio di errore API Gateway.
$context.error.messageString Valore $context.error.message tra virgolette, ovvero "$context.error.message".
$context.error.responseType

Un tipo di GatewayResponse. Per ulteriori informazioni, consulta Monitora WebSocket API l'esecuzione con CloudWatch metriche e Configurazione delle risposte del gateway per la personalizzazione delle risposte agli errori.
$context.extendedRequestId Equivalente a $context.requestId.
$context.httpMethod

Il HTTP metodo utilizzato. I valori validi sono: DELETE, GET, HEAD, OPTIONS, PATCH, POST e PUT.
$context.identity.accountId

L'ID AWS dell'account associato alla richiesta. Supportato per i percorsi che utilizzano IAM l'autorizzazione.
$context.identity.caller

Identificatore dell'entità principale dell'intermediario che ha firmato la richiesta. Supportato per i percorsi che utilizzano IAM l'autorizzazione.
$context.identity.cognitoAuthenticationProvider

Un elenco separato da virgole di tutti i provider di autenticazione Amazon Cognito utilizzati dal chiamante che effettua la richiesta. Disponibile solo se la richiesta è stata firmata con credenziali Amazon Cognito.

Ad esempio, per un'identità di un pool di utenti Amazon Cognito, cognito-idp. region.amazonaws.com/user_pool_id,cognito-idp.region.amazonaws.com/user_pool_id:CognitoSignIn:token subject claim

Per informazioni sui provider di autenticazione di Amazon Cognito disponibili, consulta Using Federated Identities nella Amazon Cognito Developer Guide.
$context.identity.cognitoAuthenticationType

Tipo di autenticazione Amazon Cognito dell'intermediario da cui proviene la richiesta. Disponibile solo se la richiesta è stata firmata con credenziali Amazon Cognito. I valori possibili includono authenticated per le identità autenticate e unauthenticated per le identità non autenticate.
$context.identity.cognitoIdentityId

ID identità di Amazon Cognito dell'intermediario da cui proviene la richiesta. Disponibile solo se la richiesta è stata firmata con credenziali Amazon Cognito.
$context.identity.cognitoIdentityPoolId

ID pool di identità di Amazon Cognito dell'intermediario da cui proviene la richiesta. Disponibile solo se la richiesta è stata firmata con credenziali Amazon Cognito.
$context.identity.principalOrgId

L'ID organizzazione AWS. Supportato per percorsi che utilizzano l'autorizzazione. IAM
$context.identity.clientCert.clientCertPem

Il certificato client PEM con codifica che il client ha presentato durante l'autenticazione reciprocaTLS. Presente quando un client accede a un API utilizzando un nome di dominio personalizzato con attivazione reciproca. TLS
$context.identity.clientCert.subjectDN

Nome distinto dell'oggetto del certificato presentato da un client. Presente quando un client accede a un API utilizzando un nome di dominio personalizzato con attivazione reciprocaTLS.
$context.identity.clientCert.issuerDN

Nome distinto dell'approvatore del certificato presentato da un cliente. Presente quando un client accede a un API utilizzando un nome di dominio personalizzato con attivazione reciprocaTLS.
$context.identity.clientCert.serialNumber

Il numero di serie del certificato. Presente quando un client accede a un API utilizzando un nome di dominio personalizzato con attivazione reciprocaTLS.
$context.identity.clientCert.validity.notBefore

La data prima della quale il certificato non è valido. Presente quando un client accede a un API utilizzando un nome di dominio personalizzato con attivazione reciprocaTLS.
$context.identity.clientCert.validity.notAfter

La data dopo la quale il certificato non è valido. Presente quando un client accede a un API utilizzando un nome di dominio personalizzato con attivazione reciprocaTLS.
$context.identity.sourceIp

L'indirizzo IP di origine della TCP connessione immediata che effettua la richiesta all'endpoint API Gateway.
$context.identity.user

Identificatore dell'entità principale dell'utente che sarà autorizzato per l'accesso alle risorse. Supportato per i percorsi che utilizzano l'IAMautorizzazione.
$context.identity.userAgent

L'User-Agentintestazione del API chiamante.
$context.identity.userArn

L'Amazon Resource Name (ARN) dell'utente effettivo identificato dopo l'autenticazione. Supportato per i percorsi che utilizzano IAM l'autorizzazione. Per ulteriori informazioni, consulta https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html.
$context.integration.error Il messaggio di errore restituito da un'integrazione. Equivalente a $context.integrationErrorMessage.
$context.integration.integrationStatus Per l'integrazione del proxy Lambda, il codice di stato restituito dal codice della funzione Lambda di backend AWS Lambda, non dal codice della funzione Lambda.
$context.integration.latency Latenza di integrazione in ms. Equivalente a $context.integrationLatency.
$context.integration.requestId L'ID della AWS richiesta dell'endpoint. Equivalente a $context.awsEndpointRequestId.
$context.integration.status Il codice di stato restituito da un'integrazione. Per le integrazioni proxy Lambda, questo è il codice di stato restituito dal codice della funzione Lambda.
$context.integrationErrorMessage

Una stringa contenente un messaggio di errore di integrazione.
$context.integrationLatency Latenza di integrazione in ms.
$context.integrationStatus Per l'integrazione del proxy Lambda, questo parametro rappresenta il codice di stato restituito dalla funzione Lambda di backend AWS Lambda, non dalla funzione Lambda di backend.
$context.path Percorso della richiesta. Ad esempio, /{stage}/root/child.
$context.protocol Protocollo della richiesta, ad esempi, HTTP/1.1.
Nota

APIGateway APIs può accettare richieste HTTP /2, ma API Gateway invia richieste alle integrazioni di backend utilizzando /1.1. HTTP Di conseguenza, il protocollo di richiesta viene registrato come HTTP /1.1 anche se un client invia una richiesta che utilizza /2. HTTP
$context.requestId

L'ID assegnato da API Gateway alla richiesta. API
$context.requestTime L'ora della richiesta in CLFformato -formattato (). dd/MMM/yyyy:HH:mm:ss +-hhmm
$context.requestTimeEpoch Ora della richiesta in formato Unix epoch.
$context.responseLatency Latenza della risposta in ms.
$context.responseLength Lunghezza del payload della risposta in byte.
$context.routeKey

La chiave di percorso della API richiesta, ad esempio. /pets
$context.stage

La fase di distribuzione della API richiesta (ad esempio, beta oprod).
$context.status Stato della risposta del metodo.