Risoluzione dei problemi di utilizzo delle API

Questa pagina fornisce agli sviluppatori di applicazioni una panoramica su come risolvere i problemi relativi all'utilizzo delle API Google e Google Cloud.

Sfondo

Le API Google sono API di rete fornite dai servizi Google. Le applicazioni possono accedere alle API di Google tramite JSON HTTP e gRPC da ambienti diversi. Consigliamo agli sviluppatori di utilizzare le librerie client fornite da Google nelle loro applicazioni. Queste librerie implementano la logica boilerplate comune, come l'autenticazione e la paginazione degli elenchi, che riducono notevolmente il sovraccarico di sviluppo e gli errori comuni.

Per ulteriori informazioni, consulta Descrizione delle librerie client

Per iniziare

Se non hai mai utilizzato le API di Google, consulta la pagina Introduzione per completare i passaggi di preparazione della tua applicazione. Devi prima utilizzare il comando curl -v per inviare richieste di test alle API Google che vuoi utilizzare. Ti consente di fare esperimenti con le API Google senza scrivere codice. Spesso è possibile risolvere molti problemi prima di iniziare lo sviluppo effettivo dell'applicazione.

Per ulteriori informazioni, consulta la guida introduttiva.

Risoluzione dei problemi relativi all'utilizzo delle metriche

Le API Google forniscono metriche API gratuite che coprono aspetti comuni dell'utilizzo delle API, tra cui conteggi delle richieste, errori, latenze, dimensioni di richieste e risposte. Forniscono dimensioni granulari in termini di applicazioni e località. Gli sviluppatori possono rilevare un utilizzo anomalo dell'API e identificare potenziali cause di fondo. Ad esempio, un numero maggiore di errori 400 può indicare che un'applicazione aggiornata di recente presenta alcuni bug logici oppure che dimensioni maggiori di richieste e risposte possono causare un rallentamento del rendimento dell'applicazione.

Per saperne di più, consulta Monitoraggio dell'utilizzo delle API.

Risoluzione dei problemi utilizzando i log

Per motivi di sicurezza e privacy, in genere le API di Google non forniscono log API agli sviluppatori di applicazioni. Consigliamo vivamente agli sviluppatori di applicazioni di registrare gli errori dell'API lato client. Puoi registrare gli errori in uno spazio di archiviazione locale o in un'API di logging remota, ad esempio l'API Cloud Logging.

In genere, i log contengono più informazioni sugli errori rispetto alle metriche, ad esempio messaggi di errore e dettagli sugli errori. Sono estremamente utili e spesso necessari per risolvere i problemi relativi alle API. Quando gli sviluppatori rilevano un problema con l'utilizzo dell'API, possono eseguire query sui log per trovare messaggi di errore e dettagli sugli errori, nonché utilizzare le informazioni per risolvere gli errori o contattare l'assistenza.

Cloud Audit Logs

Per le attività sensibili alla sicurezza, i prodotti Google Cloud potrebbero generare log di audit contenenti informazioni dettagliate sulle attività. Sono un'ottima fonte di informazioni per la risoluzione dei problemi relativi all'utilizzo delle API Google Cloud. Ad esempio, la funzionalità di prova simulata di Controlli di servizio VPC genera log di controllo per consentire agli amministratori di valutare le modifiche imminenti ai criteri.

Per ulteriori informazioni, consulta Cloud Audit Logs.

Risolvere gli errori

Se hai problemi con l'utilizzo dell'API Google e hai trovato le metriche e i log corrispondenti, puoi seguire la pagina Errori della Guida alla progettazione delle API per risolvere i problemi.

In generale, ogni errore dell'API contiene tre informazioni: codice di errore, messaggio di errore e dettagli dell'errore:

  • Il codice di errore consente alle applicazioni di gestire l'errore a un livello superiore, ad esempio riprovare dopo errori 503 o autenticare nuovamente gli utenti dopo errori 401.

  • Il messaggio di errore consente agli sviluppatori di applicazioni di comprendere l'errore e di correggere la logica dell'applicazione.

  • I dettagli dell'errore contengono informazioni aggiuntive che le applicazioni possono utilizzare per gestire l'errore in modo programmatico.

Per ulteriori informazioni, consulta la pagina Errori.