Memecahkan masalah penggunaan API

Halaman ini memberikan ringkasan kepada developer aplikasi tentang cara memecahkan masalah penggunaan Google API dan Google Cloud API.

Latar belakang

Google API adalah API jaringan yang disediakan oleh layanan Google. Aplikasi dapat mengakses Google API melalui JSON HTTP dan gRPC dari berbagai lingkungan. Sebaiknya developer menggunakan library klien yang disediakan Google dalam aplikasi mereka. Library ini menerapkan logika boilerplate umum, seperti autentikasi dan penomoran halaman daftar, yang sangat mengurangi overhead pengembangan dan kesalahan umum.

Untuk informasi selengkapnya, lihat Penjelasan Library Klien

Memulai

Jika Anda baru menggunakan Google API, Anda harus mengikuti halaman Memulai untuk menyelesaikan langkah-langkah persiapan aplikasi Anda. Anda harus menggunakan perintah curl -v terlebih dahulu untuk mengirim permintaan pengujian ke Google API yang ingin Anda gunakan. Alat ini memungkinkan Anda bereksperimen dengan Google API tanpa perlu menulis kode apa pun. Anda sering kali dapat menyelesaikan banyak masalah sebelum memulai pengembangan aplikasi yang sebenarnya.

Untuk informasi selengkapnya, lihat Memulai.

Memecahkan masalah menggunakan metrik

Google API menyediakan metrik API gratis yang mencakup aspek umum penggunaan API, termasuk jumlah permintaan, error, latensi, ukuran permintaan, dan respons. Dimensi ini memberikan dimensi yang terperinci dalam hal aplikasi dan lokasi. Developer dapat menemukan penggunaan API yang tidak wajar, dan mengidentifikasi potensi penyebab utamanya. Misalnya, error 400 yang lebih tinggi dapat berarti aplikasi yang baru saja diupdate memiliki beberapa bug logis, atau ukuran permintaan dan respons yang lebih tinggi dapat menyebabkan performa aplikasi yang lebih lambat.

Untuk informasi selengkapnya, lihat Monitoring API usage.

Memecahkan masalah menggunakan log

Untuk alasan keamanan dan privasi, Google API umumnya tidak menyediakan log API kepada developer aplikasi. Sebaiknya developer aplikasi mencatat error API di sisi klien. Anda dapat mencatat error ke penyimpanan lokal atau ke API logging jarak jauh, seperti Cloud Logging API.

Log biasanya berisi lebih banyak informasi tentang error daripada metrik, seperti pesan error dan detail error. API ini sangat berguna dan sering kali diperlukan untuk memecahkan masalah error API. Jika developer melihat masalah apa pun dengan penggunaan API mereka, mereka dapat mengkueri log untuk menemukan pesan error dan detail error, serta menggunakan informasi tersebut untuk menyelesaikan error atau menghubungi dukungan.

Cloud Audit Logs

Untuk aktivitas sensitif keamanan, produk Google Cloud dapat menghasilkan log audit yang berisi informasi mendetail tentang aktivitas tersebut. Halaman ini adalah sumber informasi yang sangat baik untuk memecahkan masalah penggunaan Google Cloud API Anda. Misalnya, fitur uji coba Kontrol Layanan VPC akan menghasilkan log audit bagi administrator untuk mengevaluasi perubahan kebijakan mendatang.

Untuk informasi selengkapnya, lihat Cloud Audit Logs.

Mengatasi error

Jika mengalami masalah terkait penggunaan Google API dan telah menemukan metrik dan log yang sesuai, Anda dapat mengikuti halaman Error Panduan Desain API untuk mengatasi error tersebut.

Secara umum, setiap error API memiliki 3 bagian informasi: kode error, pesan error, dan detail error:

  • Kode error memungkinkan aplikasi menangani error di tingkat yang lebih tinggi, seperti mencoba lagi setelah error 503 atau mengautentikasi ulang pengguna setelah error 401.

  • Pesan error memungkinkan developer aplikasi memahami error dan memperbaiki logika aplikasi mereka.

  • Detail error berisi informasi tambahan yang dapat digunakan aplikasi untuk menangani error secara terprogram.

Untuk mengetahui informasi selengkapnya, lihat halaman Error.