Passen Sie die HTTP API Zugriffsprotokolle an - APIAmazon-Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Passen Sie die HTTP API Zugriffsprotokolle an

Sie können die folgenden Variablen verwenden, um HTTP API Zugriffsprotokolle anzupassen. Weitere Informationen zu Zugriffsprotokollen für HTTP APIs finden Sie unterKonfigurieren Sie die Protokollierung für HTTP-APIs in API Gateway.

Parameter Beschreibung
$context.accountId

Die AWS Konto-ID des API Besitzers.
$context.apiId

Die Kennung, die API Gateway Ihrem API zuweist.
$context.authorizer.claims.property

Eine Eigenschaft der Ansprüche, die vom JSON Web Token (JWT) zurückgegeben wurden, nachdem der Methodenaufrufer erfolgreich authentifiziert wurde, z. B. $context.authorizer.claims.username Weitere Informationen finden Sie unter Steuern Sie den Zugriff HTTP APIs mit JWT Autorisierern in Gateway API.

Anmerkung

Bei einem Aufruf von $context.authorizer.claims wird null (0) zurückgegeben.
$context.authorizer.error Die von einem Genehmiger zurückgegebene Fehlermeldung.
$context.authorizer.principalId

Die ID des Prinzipalbenutzers, die ein Lambda-Genehmiger zurückgibt.
$context.authorizer.property

Der Wert des angegebenen Schlüssel-Wert-Paares der context Map, der von einer API Gateway-Lambda-Autorisierungsfunktion zurückgegeben wurde. Angenommen, der Genehmiger gibt folgende context-Zuweisung zurück: 

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

Der Aufruf von $context.authorizer.key gibt die Zeichenfolge "value" zurück, der Aufruf von $context.authorizer.numKey gibt 1 zurück, und der Aufruf von $context.authorizer.boolKey gibt true zurück.
$context.awsEndpointRequestId

Die Anforderungs-ID des AWS Endpunkts aus dem OR-Header. x-amz-request-id x-amzn-requestId
$context.awsEndpointRequestId2

Die Anforderungs-ID des AWS Endpunkts aus dem x-amz-id-2 Header.
$context.customDomain.basePathMatched

Der Pfad für ein API Mapping, dem eine eingehende Anfrage entsprach. Anwendbar, wenn ein Client einen benutzerdefinierten Domänennamen für den Zugriff auf einen verwendetAPI. Wenn ein Client beispielsweise eine Anfrage an https://api.example.com/v1/orders/1234 sendet und die Anfrage der API Zuordnung dem Pfad entsprichtv1/orders, lautet der Wertv1/orders. Weitere Informationen hierzu finden Sie unter APIOrdnen Sie Stufen einem benutzerdefinierten Domainnamen zu für HTTP APIs.
$context.dataProcessed Die Menge der verarbeiteten Daten in Bytes.
$context.domainName

Der vollständige Domainname, der zum Aufrufen von verwendet wurde. API Dieser Wert sollte mit dem für den eingehenden Host-Header übereinstimmen.
$context.domainPrefix

Das erste Label der $context.domainName.
$context.error.message

Eine Zeichenfolge, die eine API Gateway-Fehlermeldung enthält.
$context.error.messageString Die Wert von $context.error.message in Anführungszeichen, d. h. "$context.error.message".
$context.error.responseType

Ein Typ von GatewayResponse. Weitere Informationen erhalten Sie unter Überwachen Sie WebSocket API die Ausführung mit CloudWatch Metriken und Einrichten von Gateway-Antworten, um Fehlerantworten anzupassen.
$context.extendedRequestId Äquivalent mit $context.requestId.
$context.httpMethod

Die verwendete HTTP Methode. Gültige Werte sind: DELETE, GET, HEAD, OPTIONS, PATCH, POST und PUT.
$context.identity.accountId

Die der Anfrage zugeordnete AWS Konto-ID. Wird für Routen unterstützt, die IAM Autorisierung verwenden.
$context.identity.caller

Die Hauptkennung des Aufrufers, der die Anforderung signiert hat. Wird für Routen unterstützt, die IAM Autorisierung verwenden.
$context.identity.cognitoAuthenticationProvider

Eine durch Kommas getrennte Liste aller Amazon Cognito Cognito-Authentifizierungsanbieter, die von dem Anrufer verwendet werden, der die Anfrage stellt. Nur verfügbar, wenn die Anfrage mit Anmeldeinformationen von Amazon Cognito signiert wurde.

Zum Beispiel für eine Identität aus einem Amazon Cognito-Benutzerpool, cognito-idp. region.amazonaws.com/user_pool_id,cognito-idp.region.amazonaws.com/user_pool_id:CognitoSignIn:token subject claim

Informationen zu den verfügbaren Amazon Cognito-Authentifizierungsanbietern finden Sie unter Using Federated Identities im Amazon Cognito Developer Guide.
$context.identity.cognitoAuthenticationType

Der Amazon Cognito-Authentifizierungstyp des Aufrufers, der den Anfrage erstellt hat. Nur verfügbar, wenn die Anfrage mit Anmeldeinformationen von Amazon Cognito signiert wurde. Mögliche Werte sind authenticated für authentifizierte Identitäten und unauthenticated für nicht authentifizierte Identitäten.
$context.identity.cognitoIdentityId

Die Amazon Cognito Identitäts-ID des anfordernden Aufrufers. Nur verfügbar, wenn die Anfrage mit Anmeldeinformationen von Amazon Cognito signiert wurde.
$context.identity.cognitoIdentityPoolId

Die Amazon Cognito Identitätspool-ID des anfordernden Aufrufers. Nur verfügbar, wenn die Anfrage mit Anmeldeinformationen von Amazon Cognito signiert wurde.
$context.identity.principalOrgId

Die AWS -Organisations-ID. Wird für Routen unterstützt, die Autorisierung verwenden. IAM
$context.identity.clientCert.clientCertPem

Das PEM -kodierte Client-Zertifikat, das der Client bei der gegenseitigen TLS Authentifizierung vorgelegt hat. Vorhanden, wenn ein Client API mithilfe eines benutzerdefinierten Domänennamens, für den die Option Mutual aktiviert ist, auf eine zugreift. TLS
$context.identity.clientCert.subjectDN

Der Distinguished Name des Zertifikatantragsstellers, den ein Client präsentiert. Präsentiert, wenn ein Client API mithilfe eines benutzerdefinierten Domänennamens, für den Mutual TLS aktiviert ist, auf einen zugreift.
$context.identity.clientCert.issuerDN

Der Distinguished Name des Ausstellers des Zertifikats, das ein Client präsentiert. Präsentiert, wenn ein Client API mithilfe eines benutzerdefinierten Domänennamens, für den Mutual TLS aktiviert ist, auf einen zugreift.
$context.identity.clientCert.serialNumber

Die Seriennummer des Zertifikats. Präsentiert, wenn ein Client API mithilfe eines benutzerdefinierten Domänennamens, für den Mutual TLS aktiviert ist, auf einen zugreift.
$context.identity.clientCert.validity.notBefore

Das Datum, vor dem das Zertifikat ungültig ist. Präsentiert, wenn ein Client API mithilfe eines benutzerdefinierten Domänennamens, für den Mutual TLS aktiviert ist, auf einen zugreift.
$context.identity.clientCert.validity.notAfter

Das Datum, nach dem das Zertifikat ungültig ist. Präsentiert, wenn ein Client API mithilfe eines benutzerdefinierten Domänennamens, für den Mutual TLS aktiviert ist, auf einen zugreift.
$context.identity.sourceIp

Die Quell-IP-Adresse der unmittelbaren TCP Verbindung, die die Anfrage an den API Gateway-Endpunkt stellt.
$context.identity.user

Die Hauptkennung des Benutzers, der für den Ressourcenzugriff autorisiert wird. Wird für Routen unterstützt, die IAM Autorisierung verwenden.
$context.identity.userAgent

Der User-AgentHeader des API Anrufers.
$context.identity.userArn

Der Amazon-Ressourcenname (ARN) des effektiven Benutzers, der nach der Authentifizierung identifiziert wurde. Wird für Routen unterstützt, die IAM Autorisierung verwenden. Weitere Informationen finden Sie unter https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html.
$context.integration.error Die von einer Integration zurückgegebene Fehlermeldung. Äquivalent mit $context.integrationErrorMessage.
$context.integration.integrationStatus Bei der Lambda-Proxyintegration wurde der Statuscode vom Lambda-Funktionscode zurückgegeben AWS Lambda, nicht vom Backend-Funktionscode.
$context.integration.latency Die Integrationslatenz in Millisekunden. Äquivalent mit $context.integrationLatency.
$context.integration.requestId Die AWS Anforderungs-ID des Endpunkts. Äquivalent mit $context.awsEndpointRequestId.
$context.integration.status Der von einer Integration zurückgegebene Statuscode. Bei Lambda-Proxy-Integrationen ist dies der Statuscode, der von Ihrem Lambda-Funktionscode zurückgegeben wird.
$context.integrationErrorMessage

Eine Zeichenfolge, die eine Integrationsfehlermeldung enthält.
$context.integrationLatency Die Integrationslatenz in Millisekunden.
$context.integrationStatus Bei der Lambda-Proxyintegration stellt dieser Parameter den Statuscode dar, der von der Backend-Lambda-Funktion zurückgegeben wird AWS Lambda, nicht von der Backend-Funktion.
$context.path Der Anforderungspfad. Beispiel, /{stage}/root/child.
$context.protocol Das Anforderungsprotokoll ist z. B, HTTP/1.1.
Anmerkung

APIGateway APIs kann /2-Anfragen annehmenHTTP, aber API Gateway sendet Anfragen mit /1.1 an Backend-Integrationen. HTTP Daher wird das Anforderungsprotokoll auch dann als HTTP /1.1 protokolliert, wenn ein Client eine Anfrage sendet, die /2 verwendet. HTTP
$context.requestId

Die ID, die API Gateway der Anfrage zuweist. API
$context.requestTime Die Uhrzeit der Anfrage CLFim -Format (). dd/MMM/yyyy:HH:mm:ss +-hhmm
$context.requestTimeEpoch Die Anforderungszeit im Epoch-Format.
$context.responseLatency Die Antwortlatenz in Millisekunden.
$context.responseLength Die Länge der Antwortnutzlast in Byte.
$context.routeKey

Zum Beispiel der Routenschlüssel der API Anfrage. /pets
$context.stage

Die Bereitstellungsphase der API Anfrage (z. B. beta oderprod).
$context.status Der Status der Methodenantwort.