Fehler bei der API-Nutzung beheben

Mit der Diagnosetelemetrie und der Fehleranalyse können Sie Anfragen fehler in Google APIs und Cloud de Confiance by S3NS APIs identifizieren und beheben. Sie können API-Nutzungsmesswerte, clientseitige Logs, Cloud-Audit-Logs und strukturierte Fehlerantworten untersuchen, um die Ursachen in Ihren Anwendungen zu diagnostizieren.

Hintergrund

Google APIs sind Netzwerk-APIs, die von Google-Diensten bereitgestellt werden. Anwendungen können über JSON HTTP und gRPC aus verschiedenen Umgebungen auf Google APIs zugreifen. Wir empfehlen Entwicklern, in ihren Anwendungen von Google bereitgestellte Clientbibliotheken zu verwenden. Diese Bibliotheken implementieren allgemeine Boilerplate-Logik wie Authentifizierung und Listenpaginierung, wodurch der Entwicklungsaufwand und häufige Fehler erheblich reduziert werden.

Weitere Informationen finden Sie unter Erläuterung der Clientbibliotheken.

Erste Schritte

Wenn Sie noch nicht mit Google APIs vertraut sind, folgen Sie der Seite Erste Schritte, um die Vorbereitungsschritte für Ihre Anwendung abzuschließen. Sie sollten zuerst den Befehl curl -v verwenden, um Testanfragen an Google APIs zu senden, die Sie verwenden möchten. Sie können damit mit Google APIs experimentieren, ohne Code schreiben zu müssen. Viele Probleme lassen sich oft beheben, bevor Sie mit der eigentlichen Anwendungsentwicklung beginnen.

Weitere Informationen finden Sie unter Erste Schritte.

Fehlerbehebung mit Messwerten

Google APIs bieten kostenlose API-Messwerte, die allgemeine Aspekte der API-Nutzung abdecken, einschließlich Anzahl der Anfragen, Fehler, Latenzen, Anfrage- und Antwortgrößen. Sie bieten detaillierte Dimensionen zu Anwendungen und Standorten. Entwickler können eine abnormale API-Nutzung erkennen und potenzielle Ursachen identifizieren. Fehler mit einer höheren Anzahl von 400 können beispielsweise bedeuten, dass eine kürzlich aktualisierte Anwendung logische Fehler aufweist oder höhere Anfrage- und Antwortgrößen zu einer geringeren Anwendungsleistung führen können.

Weitere Informationen finden Sie unter Monitoring API-Nutzung.

Fehlerbehebung mit Logs

Aus Sicherheits- und Datenschutzgründen stellen Google APIs in der Regel keine API-Logs für Anwendungsentwickler bereit. Wir empfehlen Anwendungsentwicklern API-Fehler auf der Clientseite. Sie können die Fehler entweder in einem lokalen Speicher oder in einer Remote-Logging API wie der Cloud Logging API protokollieren.

Logs enthalten in der Regel mehr Informationen zu Fehlern als Messwerte, z. B. Fehlermeldungen und Fehlerdetails. Sie sind äußerst nützlich und oft notwendig, um API-Fehler zu beheben. Wenn Entwickler ein Problem mit ihrer API-Nutzung feststellen, können sie die Logs abfragen, um Fehlermeldungen und Fehlerdetails zu finden, und die Informationen verwenden, um die Fehler zu beheben oder sich an den Support zu wenden.

Cloud-Audit-Logs

Bei sicherheitsrelevanten Aktivitäten können Google Cloud-Produkte Audit-Logs generieren, die detaillierte Informationen zu den Aktivitäten enthalten. Sie sind eine gute Informationsquelle für die Fehlerbehebung bei der Verwendung von Google Cloud APIs. Beispielsweise generiert das Probelauffeature von VPC Service Controls Audit-Logs für Administratoren, um die bevorstehenden Richtlinienänderungen zu bewerten.

Weitere Informationen finden Sie unter Cloud-Audit-Logs.

Fehler beheben

Wenn Sie Probleme mit der Verwendung der Google API haben und die entsprechenden Messwerte und Logs gefunden haben, können Sie die Fehler mithilfe der Fehlerseite im API-Designleitfaden beheben.

Im Allgemeinen enthält jeder API-Fehler drei Informationseinheiten: Fehlercode, Fehlermeldung und Fehlerdetails:

  • Mit dem Fehlercode können Anwendungen den Fehler auf einer höheren Ebene verarbeiten, z. B. Wiederholung nach 503-Fehlern oder Neuauthentifizierung von Nutzern nach 401-Fehlern.
  • Mit der Fehlermeldung können Anwendungsentwickler den Fehler verstehen und ihre Anwendungslogik beheben.

  • Die Fehlerdetails enthalten zusätzliche Informationen, mit denen die Anwendungen den Fehler programmatisch beheben können.

Weitere Informationen finden Sie auf der Seite Fehler.