Informationen zum Audit-Logging von API Gateway

Auf dieser Seite werden die Audit-Logs beschrieben, die von API Gateway als Teil von Cloud-Audit-Logs erstellt werden.

Überblick

Google Cloud-Dienste schreiben Audit-Logs, aus denen in Bezug auf Ihre Google Cloud-Ressourcen hervorgeht, wer was wo und wann getan hat.

Ihre Google Cloud-Projekte enthalten nur die Audit-Logs für Ressourcen, die sich direkt im Cloud-Projekt befinden. Andere Google Cloud-Ressourcen wie Ordner, Organisationen und Rechnungskonten enthalten jeweils eigene Audit-Logs.

Eine allgemeine Übersicht über Cloud-Audit-Logs finden Sie unter Cloud-Audit-Logs. Detaillierte Informationen zum Audit-Logformat finden Sie unter Audit-Logs verstehen.

Verfügbare Audit-Logs

Für API Gateway sind folgende Audit-Logtypen verfügbar:

Audit-Logs zur Administratoraktivität

Umfasst „Admin Write“-Vorgänge, die Metadaten oder Konfigurationsinformationen schreiben.

Sie können Audit-Logs zu Administratoraktivitäten nicht deaktivieren.
Audit-Logs zum Datenzugriff

Umfasst „Admin Read“-Vorgänge“, die Metadaten oder Konfigurationsinformationen lesen. Umfasst auch „Data Read“- und „Data Write“-Vorgänge, die von Nutzern bereitgestellte Daten lesen oder schreiben.

Um Datenzugriffs-Audit-Logs zu erhalten, müssen Sie sie explizit aktivieren.

Ausführlichere Beschreibungen der Audit-Logtypen finden Sie unter Arten von Audit-Logs.

Geprüfte Vorgänge

Nachfolgend finden Sie eine Zusammenstellung der API-Vorgänge mit dem entsprechenden jeweiligen Audit-Logtyp in API Gateway:

Audit-Logkategorie API-Gateway-Vorgänge

Administratoraktivität

Audit-Logkategorie	API-Gateway-Vorgänge
Administratoraktivität	Gateway-Vorgänge: `CreateGateway` `UpdateGateway` `DeleteGateway` API-Vorgänge: `CreateApi` `UpdateApi` `DeleteApi` APIConfig-Vorgänge: `CreateApiConfig` `UpdateApiConfig` `DeleteApiConfig` IAM-Vorgänge (Identity and Access Management – Identitäts- und Zugriffsverwaltung): `SetIamPolicy(Gateways)` `SetIamPolicy(APIs)` `SetIamPolicy(APIConfigs)` Vorgänge: `CancelOperation` `DeleteOperation`
Datenzugriffslogs (`ADMIN_READ`)	Gateway-Vorgänge: `GetGateway` `ListGateways` API-Vorgänge: `GetApi` `ListApis` APIConfig-Vorgänge: `GetApiConfig` `ListApiConfigs` IAM-Vorgänge (Identity and Access Management – Identitäts- und Zugriffsverwaltung): `GetIamPolicy(Gateways)` `GetIamPolicy(APIs)` `GetIamPolicy(APIConfigs)` Vorgänge: `GetOperation` `ListOperations` Standortvorgänge: `GetLocation` `ListLocations`

Gateway-Vorgänge:

CreateGateway
UpdateGateway
DeleteGateway

API-Vorgänge:

CreateApi
UpdateApi
DeleteApi

APIConfig-Vorgänge:

CreateApiConfig
UpdateApiConfig
DeleteApiConfig

IAM-Vorgänge (Identity and Access Management – Identitäts- und Zugriffsverwaltung):

SetIamPolicy(Gateways)
SetIamPolicy(APIs)
SetIamPolicy(APIConfigs)

Vorgänge:

CancelOperation
DeleteOperation

Datenzugriffslogs (ADMIN_READ)

Gateway-Vorgänge:

GetGateway
ListGateways

API-Vorgänge:

GetApi
ListApis

APIConfig-Vorgänge:

GetApiConfig
ListApiConfigs

IAM-Vorgänge (Identity and Access Management – Identitäts- und Zugriffsverwaltung):

GetIamPolicy(Gateways)
GetIamPolicy(APIs)
GetIamPolicy(APIConfigs)

Vorgänge:

GetOperation
ListOperations

Standortvorgänge:

GetLocation
ListLocations

Audit-Log-Format

Audit-Logeinträge umfassen folgende Komponenten:

Den Logeintrag selbst. Dabei handelt es sich um ein Objekt vom Typ LogEntry. Interessante Felder sind unter anderem:
- logName enthält die Ressourcen-ID und den Audit-Logtyp.
- resource enthält das Ziel zum geprüften Vorgang
- timeStamp enthält die Uhrzeit des geprüften Vorgangs
- protoPayload enthält die geprüften Informationen
Die Audit-Logdaten, bei denen es sich um ein AuditLog-Objekt handelt, das sich im Feld protoPayload des Logeintrags befindet
Optionale dienstspezifische Auditinformationen. Das Objekt ist dienstspezifisch. Bei älteren Integrationen befindet sich dieses Objekt im Feld serviceData des AuditLog-Objekts. Neuere Integrationen verwenden das Feld metadata.

Informationen zu anderen Feldern in diesen Objekten sowie zu deren Interpretation finden Sie unter Audit-Logs verstehen.

Logname

Ressourcennamen von Cloud-Audit-Logs geben Aufschluss über das Cloud-Projekt oder über eine andere Google Cloud-Entität, die Inhaber der Audit-Logs ist. Sie zeigen außerdem an, ob das Log Audit-Logging-Daten zur Administratoraktivität, zum Datenzugriff, zu abgelehnten Richtlinien oder zu Systemereignissen enthält. Im folgenden Beispiel sind Lognamen für Audit-Logs zur Administratoraktivität auf Projektebene und für die Audit-Logs einer Organisation zum Datenzugriff enthalten. Die Variablen bezeichnen Cloud-Projekt- und Organisations-IDs.

projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity

organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access

Dienstname

API-Gateway-Audit-Logs verwenden den Dienstnamen "apigateway.googleapis.com".

Eine vollständige Liste aller Cloud Logging API-Dienstnamen und des jeweiligen überwachten Ressourcentyps finden Sie unter Dienste Ressourcen zuordnen.

Ressourcentypen

API-Gateway-Audit-Logs verwenden den Ressourcentyp "audited_resource" für alle Audit-Logs.

Eine Liste aller überwachten Cloud Logging-Ressourcentypen und beschreibende Informationen finden Sie unter Überwachte Ressourcentypen.

Audit-Logging aktivieren

Audit-Logs zu Administratoraktivitäten sind immer aktiviert. Sie können sie nicht deaktivieren.

Audit-Logs zum Datenzugriff sind standardmäßig deaktiviert und werden nur geschrieben, wenn sie explizit aktiviert werden. Eine Ausnahme bilden die Audit-Logs zum Datenzugriff für BigQuery, die nicht deaktiviert werden können.

Eine Anleitung zum Aktivieren einiger oder aller Audit-Logs zu Datenzugriffen finden Sie unter Datenzugriffslogs konfigurieren.

Berechtigungen und Rollen

IAM-Berechtigungen und -Rollen bestimmen Ihre Fähigkeit, auf Audit-Logdaten in Google Cloud-Ressourcen zuzugreifen.

Berücksichtigen Sie Folgendes bei der Entscheidung, welche Logging-spezifischen Berechtigungen und Rollen für Ihren Anwendungsfall gelten:

Die Rolle „Log-Betrachter“ (roles/logging.viewer) bietet Ihnen Lesezugriff auf die Audit-Logs zu Administratoraktivitäten, abgelehnten Richtlinien und Systemereignissen. Wenn Sie nur diese Rolle haben, können Sie keine Audit-Logs zum Datenzugriff aufrufen, die sich in den Buckets _Required und _Default befinden.
Die Rolle „Betrachter privater Logs“ (roles/logging.privateLogViewer) enthält die Berechtigungen, die in roles/logging.viewer enthalten sind, sowie die Möglichkeit, Audit-Logs zum Datenzugriff in den Buckets _Required und _Default zu lesen.

Wenn diese privaten Logs in benutzerdefinierten Buckets gespeichert sind, kann jeder Nutzer, der Berechtigungen zum Lesen von Logs in diesen Buckets hat, die privaten Logs lesen. Weitere Informationen zu Log-Buckets finden Sie unter Routing und Speicher.

Weitere Informationen zu den IAM-Berechtigungen und -Rollen, die für Audit-Logdaten gelten, finden Sie unter Zugriffssteuerung mit IAM.

Logs ansehen

Wenn Sie Audit-Logs suchen und ansehen möchten, müssen Sie die ID des Cloud-Projekts, des Ordners oder der Organisation kennen, für die Sie Audit-Logging-Informationen abrufen möchten. Sie können weitere indexierte LogEntry-Felder angeben, z. B. resource.type. Weitere Informationen finden Sie unter Logeinträge schnell finden.

Im Folgenden finden Sie die Namen der Audit-Logs. Sie enthalten Variablen für die IDs des Cloud-Projekts, des Ordners oder der Organisation.

   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fpolicy

   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Factivity
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fpolicy

   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Factivity
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fpolicy

Sie können Audit-Logs in Cloud Logging mit der Cloud Console, dem gcloud-Befehlszeilentool oder der Logging API aufrufen.

Console

In der Cloud Console können Sie mit dem Log-Explorer die Audit-Logeinträge für Ihr Cloud-Projekt, Ihren Ordner oder Ihre Organisation abrufen:

Rufen Sie in der Cloud Console die Seite Logging > Log-Explorer auf.

Zum Log-Explorer
Hinweis: Wenn Sie sich auf der Seite Legacy-Loganzeige befinden, wechseln Sie zur Seite Log-Explorer.
Wählen Sie auf der Seite Log-Explorer ein vorhandenes Cloud-Projekt, einen Ordner oder eine Organisation aus.
Führen Sie im Bereich Query Builder folgende Schritte aus:
- Wählen Sie unter Ressourcentyp die Google Cloud-Ressource aus, deren Audit-Logs angezeigt werden sollen.
- Wählen Sie unter Logname den Audit-Logtyp aus, den Sie sehen möchten:
  - Wählen Sie für Audit-Logs zu Administratoraktivitäten die Option activity aus.
  - Wählen Sie für Audit-Logs zum Datenzugriff die Option data_access aus.
  - Wählen Sie für Audit-Logs zu Systemereignissen die Option system_event aus.
  - Wählen Sie für Audit-Logs zu Richtlinienverstößen die Option policy aus.
Wenn diese Optionen nicht angezeigt werden, sind im Cloud-Projekt, im Ordner oder in der Organisation keine Audit-Logs dieses Typs verfügbar.

Weitere Informationen zu Abfragen mit dem Log-Explorer finden Sie unter Logabfragen erstellen.

gcloud

Das gcloud-Befehlszeilentool bietet eine Befehlszeile für die Cloud Logging API. Geben Sie dabei in jedem Lognamen eine gültige PROJECT_ID, FOLDER_ID oder ORGANIZATION_ID an.

Führen Sie den folgenden Befehl aus, um Ihre Audit-Logeinträge auf Google Cloud-Projektebene zu lesen:

gcloud logging read "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com" --project=PROJECT_ID

Führen Sie den folgenden Befehl aus, um Ihre Audit-Logeinträge auf Ordnerebene zu lesen:

gcloud logging read "logName : folders/FOLDER_ID/logs/cloudaudit.googleapis.com" --folder=FOLDER_ID

Führen Sie den folgenden Befehl aus, um Ihre Audit-Logeinträge auf Organisationsebene zu lesen:

gcloud logging read "logName : organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com" --organization=ORGANIZATION_ID

Weitere Informationen zur Verwendung des gcloud-Tools finden Sie unter Logeinträge lesen.

API

Ersetzen Sie beim Erstellen Ihrer Abfragen die Variablen durch gültige Werte. Ersetzen Sie den entsprechenden Audit-Lognamen auf Projekt-, Ordner- oder Organisationsebene oder verwenden Sie die in den Audit-Lognamen aufgeführten IDs. Wenn die Abfrage beispielsweise eine PROJECT_ID enthält, muss sich die von Ihnen angegebene Projekt-ID auf das aktuell ausgewählte Cloud-Projekt beziehen.

So rufen Sie Ihre Audit-Logeinträge mit der Logging API auf:

Rufen Sie den Abschnitt Diese API testen in der Dokumentation für die Methode entries.list auf.
Geben Sie im Teil Anfragetext des Formulars Diese API testen Folgendes ein. Wenn Sie auf dieses vorausgefüllte Formular klicken, wird der Anfragetext automatisch übernommen. Sie müssen jedoch in jedem der Lognamen eine gültige PROJECT_ID angeben.
```
{
  "resourceNames": [
    "projects/PROJECT_ID"
  ],
  "pageSize": 5,
  "filter": "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com"
}
```
Klicken Sie auf Ausführen.

Weitere Informationen zu Abfragen finden Sie unter Logging-Abfragesprache.

Ein Beispiel für einen Audit-Logeintrag und wie Sie die wichtigsten Informationen darin finden, sehen Sie unter Beispiel für einen Audit-Logeintrag.

Audit-Logs weiterleiten

Sie können Audit-Logs auf dieselbe Weise wie andere Arten von Logs an unterstützte Ziele weiterleiten. Im Folgenden erfahren Sie, warum es sinnvoll sein kann, Ihre Audit-Logs weiterzuleiten:

Sie können Kopien Ihrer Audit-Logs an Cloud Storage, BigQuery oder Pub/Sub weiterleiten, um Audit-Logs für einen längeren Zeitraum aufzubewahren oder leistungsfähigere Suchfunktionen zu nutzen. Mit Pub/Sub haben Sie die Möglichkeit, die Logs an andere Anwendungen, andere Repositories und Dritte weiterzuleiten.
Zum organisationsübergreifenden Verwalten Ihrer Audit-Logs erstellen Sie aggregierte Senken, mit denen sich Logs aus beliebigen oder allen Cloud-Projekten in der Organisation weiterleiten lassen.

Wenn die aktivierten Audit-Logs zum Datenzugriff dazu führen, dass Ihre Cloud-Projekte Ihre Logkontingente überschreiten, können Sie Senken erstellen, die die Audit-Logs zum Datenzugriff aus Logging ausschließen.

Eine Anleitung zum Weiterleiten von Logs finden Sie unter Senken konfigurieren.

Preise

Audit-Logs zur Administratoraktivität und Audit-Logs zu Systemereignissen sind kostenlos.

Audit-Logs zum Datenzugriff und die Audit-Logs zu Richtlinienverstößen sind kostenpflichtig.

Weitere Informationen zu den Preisen für Cloud Logging finden Sie unter Operations-Suite von Google Cloud – Preise: Cloud Logging.