Personnaliser les journaux HTTP API d'accès - APIPasserelle Amazon

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Personnaliser les journaux HTTP API d'accès

Vous pouvez utiliser les variables suivantes pour personnaliser les journaux HTTP API d'accès. Pour en savoir plus sur les journaux d'accès pour HTTPAPIs, voirConfiguration de la journalisation pour les API HTTP dans API Gateway.

Paramètre Description
$context.accountId

L'identifiant du AWS compte du API propriétaire.
$context.apiId

L'identifiant que API Gateway attribue à votre. API
$context.authorizer.claims.property

Une propriété des demandes renvoyées par le jeton JSON Web (JWT) une fois que l'appelant de la méthode a été authentifié avec succès, telle que. $context.authorizer.claims.username Pour plus d’informations, consultez Contrôlez l'accès à l'HTTPAPIsaide des JWT autorisateurs dans Gateway API.

Note

L'appel de $context.authorizer.claims renvoie la valeur null.
$context.authorizer.error Message d'erreur renvoyé par un mécanisme d'autorisation.
$context.authorizer.principalId

Identification de l'utilisateur principal renvoyée par un mécanisme d'autorisation Lambda.
$context.authorizer.property

La valeur de la paire clé-valeur spécifiée de la context carte renvoyée par une fonction d'autorisation Gateway API Lambda. Par exemple, si le mécanisme d'autorisation retourne le mappage context suivant : 

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

l'appel $context.authorizer.key renvoie la chaîne "value", l'appel $context.authorizer.numKey renvoie 1 et l'appel $context.authorizer.boolKey renvoie true.
$context.awsEndpointRequestId

L'ID de demande du AWS point de terminaison indiqué dans l'x-amzn-requestIden-tête x-amz-request-id ou.
$context.awsEndpointRequestId2

L'ID de demande du AWS point de terminaison indiqué dans l'x-amz-id-2en-tête.
$context.customDomain.basePathMatched

Le chemin d'un API mappage auquel correspond une demande entrante. Applicable lorsqu'un client utilise un nom de domaine personnalisé pour accéder à unAPI. Par exemple, si un client envoie une demande àhttps://api.example.com/v1/orders/1234, et que la demande correspond au API mappage avec le cheminv1/orders, la valeur estv1/orders. Pour en savoir plus, consultez la section Associez API les étapes à un nom de domaine personnalisé pour HTTP APIs.
$context.dataProcessed Quantité de données traitées en octets.
$context.domainName

Le nom de domaine complet utilisé pour invoquer leAPI. Il doit être identique à l'en-tête Host entrant.
$context.domainPrefix

Première étiquette de $context.domainName.
$context.error.message

Chaîne contenant un message d'erreur de API passerelle.
$context.error.messageString La valeur entre guillemets de $context.error.message, à savoir "$context.error.message".
$context.error.responseType

Type de GatewayResponse. Pour de plus amples informations, veuillez consulter Surveillez WebSocket API l'exécution à l'aide de CloudWatch métriques et Configuration de réponses de passerelle pour personnaliser des réponses d'erreur.
$context.extendedRequestId Équivalent à $context.requestId.
$context.httpMethod

La HTTP méthode utilisée. Les valeurs valides sont les suivantes : DELETE, GET, HEAD, OPTIONS, PATCH, POST et PUT.
$context.identity.accountId

L'ID de AWS compte associé à la demande. Pris en charge pour les itinéraires utilisant IAM l'autorisation.
$context.identity.caller

Identifiant principal de l'appelant qui a signé la demande. Pris en charge pour les itinéraires utilisant IAM l'autorisation.
$context.identity.cognitoAuthenticationProvider

Liste séparée par des virgules de tous les fournisseurs d'authentification Amazon Cognito utilisés par l'appelant à l'origine de la demande. Disponible uniquement si la demande a été signée avec les informations d'identification Amazon Cognito.

Par exemple, pour une identité provenant d'un pool d'utilisateurs Amazon Cognito, cognito-idp. region.amazonaws.com/user_pool_id,cognito-idp.region.amazonaws.com/user_pool_id:CognitoSignIn:token subject claim

Pour plus d'informations sur les fournisseurs d'authentification Amazon Cognito disponibles, consultez la section Utilisation des identités fédérées dans le manuel Amazon Cognito Developer Guide.
$context.identity.cognitoAuthenticationType

Type d'authentification Amazon Cognito de l'appelant effectuant la demande. Disponible uniquement si la demande a été signée avec les informations d'identification Amazon Cognito. Les valeurs possibles incluent authenticated pour les identités authentifiées et unauthenticated pour les identités non authentifiées.
$context.identity.cognitoIdentityId

ID d'identité Amazon Cognito de l'appelant effectuant la demande. Disponible uniquement si la demande a été signée avec les informations d'identification Amazon Cognito.
$context.identity.cognitoIdentityPoolId

ID de groupe d'identités Amazon Cognito de l'appelant effectuant la demande. Disponible uniquement si la demande a été signée avec les informations d'identification Amazon Cognito.
$context.identity.principalOrgId

ID d’organisation AWS. Pris en charge pour les itinéraires utilisant IAM l'autorisation.
$context.identity.clientCert.clientCertPem

Le certificat client PEM codé que le client a présenté lors de l'TLSauthentification mutuelle. Présent lorsqu'un client accède à un API en utilisant un nom de domaine personnalisé TLS activé mutuellement.
$context.identity.clientCert.subjectDN

Nom distinctif de l'objet du certificat présenté par un client. Présent lorsqu'un client accède à un API en utilisant un nom de domaine personnalisé TLS activé mutuellement.
$context.identity.clientCert.issuerDN

Nom distinctif de l'émetteur du certificat présenté par un client. Présent lorsqu'un client accède à un API en utilisant un nom de domaine personnalisé TLS activé mutuellement.
$context.identity.clientCert.serialNumber

Numéro de série du certificat. Présent lorsqu'un client accède à un API en utilisant un nom de domaine personnalisé TLS activé mutuellement.
$context.identity.clientCert.validity.notBefore

Date avant laquelle le certificat n'est pas valide. Présent lorsqu'un client accède à un API en utilisant un nom de domaine personnalisé TLS activé mutuellement.
$context.identity.clientCert.validity.notAfter

Date après laquelle le certificat n'est pas valide. Présent lorsqu'un client accède à un API en utilisant un nom de domaine personnalisé TLS activé mutuellement.
$context.identity.sourceIp

Adresse IP source de la TCP connexion immédiate qui envoie la demande au point de terminaison API Gateway.
$context.identity.user

Identifiant principal de l'utilisateur qui sera autorisé à accéder aux ressources. Pris en charge pour les itinéraires utilisant IAM l'autorisation.
$context.identity.userAgent

L'User-Agenten-tête de l'APIappelant.
$context.identity.userArn

Le nom de ressource Amazon (ARN) de l'utilisateur effectif identifié après l'authentification. Pris en charge pour les itinéraires utilisant IAM l'autorisation. Pour plus d’informations, consultez https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html.
$context.integration.error Message d'erreur renvoyé à partir d'une intégration. Équivalent à $context.integrationErrorMessage.
$context.integration.integrationStatus Pour l'intégration du proxy Lambda, le code d'état est renvoyé par le code de fonction Lambda principal AWS Lambda, et non par le code de fonction Lambda principal.
$context.integration.latency Latence d'intégration en millisecondes (ms). Équivalent à $context.integrationLatency.
$context.integration.requestId ID de demande du AWS point de terminaison. Équivalent à $context.awsEndpointRequestId.
$context.integration.status Code d'état renvoyé à partir d'une intégration. Pour les intégrations de proxy Lambda, code d'état que votre code de fonction Lambda renvoie.
$context.integrationErrorMessage

Chaîne contenant un message d'erreur d'intégration.
$context.integrationLatency Latence d'intégration en millisecondes (ms).
$context.integrationStatus Pour l'intégration du proxy Lambda, ce paramètre représente le code d'état renvoyé par la fonction Lambda principale AWS Lambda, et non par celle-ci.
$context.path Chemin d'accès de la demande. Par exemple, /{stage}/root/child.
$context.protocol Protocole de demande, par exempl, HTTP/1.1.
Note

APIGateway APIs peut accepter HTTP /2 requêtes, mais API Gateway envoie des demandes aux intégrations de backend en utilisant /1.1. HTTP Par conséquent, le protocole de demande est enregistré sous HTTP /1.1 même si un client envoie une demande utilisant HTTP /2.
$context.requestId

ID attribué par API Gateway à la API demande.
$context.requestTime L'heure CLFde la demande formatée ()dd/MMM/yyyy:HH:mm:ss +-hhmm.
$context.requestTimeEpoch Durée des demandes au format Epoch.
$context.responseLatency Latence de la réponse en millisecondes (ms).
$context.responseLength La longueur de la charge utile de la réponse en octets.
$context.routeKey

La clé de route de la API demande, par exemple/pets.
$context.stage

L'étape de déploiement de la API demande (par exemple, beta ouprod).
$context.status Statut de la réponse de la méthode.