Menggunakan APIs Explorer

Panduan ini menjelaskan cara menggunakan APIs Explorer untuk mencoba metode Cloud Monitoring API. APIs Explorer adalah widget yang terpasang ke halaman referensi REST API untuk suatu metode. Panel ini muncul sebagai panel dengan judul Coba API ini. Screenshot berikut menunjukkan panel seperti yang ditampilkan untuk metode yang hanya memiliki satu parameter, name:

APIs Explorer adalah cara terbaik untuk mencoba metode di Cloud Monitoring API tanpa harus menulis kode apa pun. Widget menampilkan formulir yang menunjukkan parameter untuk setiap metode. Isi formulir, klik tombol Execute, dan lihat hasilnya.

Anda juga dapat menyembunyikan widget dengan mengklik tombol , atau meluaskan widget ke layar penuh dengan mengklik tombol .

Catatan: Jika memperluas APIs Explorer ke layar penuh, Anda dapat melihat permintaan sebagai perintah cURL, sebagai permintaan HTTP, dan dalam JavaScript.

Tombol Coba!

Dalam dokumentasi, Anda mungkin melihat tombol Coba! seperti berikut:

Cobalah!

Saat Anda mengklik tombol tersebut, APIs Explorer di halaman referensi metode akan terbuka. Biasanya, beberapa parameter yang sesuai dengan contoh akan diisi. Namun, Anda mungkin harus mengedit beberapa parameter agar cocok dengan project Anda sendiri, seperti nilai untuk [PROJECT_ID].

Untuk mengetahui informasi tentang cara menghindari dan memperbaiki error, lihat Memecahkan masalah.

Mengakses APIs Explorer

APIs Explorer dilampirkan ke halaman referensi untuk setiap metode REST API. Untuk menemukan widget, lihat halaman referensi untuk suatu metode, misalnya, lihat metricDescriptors.list.

Menjalankan permintaan

Sebagian besar metode memiliki beberapa parameter yang diperlukan dan beberapa yang opsional. Metrik yang diperlukan akan ditandai dengan batang merah sampai terisi. Anda dapat menjalankan permintaan setelah memberikan nilai untuk semua argumen yang diperlukan.

Metode metricDescriptors.list menampilkan deskripsi untuk semua jenis metrik yang tersedia dalam sebuah project. Satu-satunya parameter yang diperlukan adalah parameter name.

Untuk menjalankan metode metricDescriptors.list, lakukan hal berikut:

1. Klik Coba!
2. Di parameter name, masukkan ID project menggunakan format projects/[PROJECT_ID]. Pastikan untuk mengganti [PROJECT_ID] dengan ID project Anda.
3. Klik Jalankan. Untuk menjalankan perintah, APIs Explorer memerlukan akses ke akun Anda. Saat diminta, pilih akun dan klik Izinkan. Akses diberikan untuk jangka waktu terbatas dan dibatasi untuk metode API yang Anda jalankan.

Hasil pemanggilan metode akan muncul dalam kotak yang memiliki header hijau atau merah. Saat permintaan berhasil, kotak memiliki header hijau dengan kode status HTTP 200 di dalamnya. Hasil pemanggilan ada dalam kotak:

Jika header berwarna merah, artinya header berisi kode kegagalan HTTP, dan kotak tersebut berisi pesan error. Untuk mengetahui informasi tentang cara menyelesaikan error, lihat Memecahkan masalah.

Catatan: Setelah Anda mengonfigurasi APIs Explorer, lalu mengklik Execute, URL halaman akan berubah. Anda dapat mem-bookmark URL yang diperbarui. Jika Anda ingin menjalankan metode lagi, klik bookmark untuk membuka halaman dengan formulir yang sudah diisi dengan pilihan Anda sebelumnya.

Menyediakan parameter tambahan

Daftar parameter yang Anda lihat bergantung pada metode yang digunakan untuk melampirkan widget API Explorer. Misalnya, metode metricDescriptors.list memiliki lebih dari parameter name, tetapi name adalah satu-satunya parameter yang diperlukan.

Jika hanya memberikan nama project, semua deskriptor metrik yang tersedia dalam project akan tersedia, dan ada banyak di antaranya. Untuk membatasi pengambilan ke kumpulan yang lebih kecil, gunakan parameter filter.

Misalnya, untuk mencantumkan hanya jenis metrik yang namanya diakhiri dengan utilization, lakukan tindakan berikut:

1. Klik Coba!

2. Di parameter name, masukkan ID project menggunakan format projects/[PROJECT_ID]. Pastikan untuk mengganti [PROJECT_ID] dengan ID project Anda.

3. Pastikan parameter filter memiliki nilai metric.type=ends_with("utilization")

4. Klik Execute dan selesaikan dialog otorisasi.

Parameter standar

Secara default, kumpulan parameter yang ditampilkan APIs Explorer sesuai dengan parameter metode terkait. Namun, widget APIs Explorer juga memiliki kumpulan parameter tambahan yang bukan bagian dari metode itu sendiri. Untuk menampilkan parameter tambahan, klik Tampilkan parameter standar:

Untuk menyembunyikan parameter tambahan dari tampilan, klik Sembunyikan parameter standar.

Parameter standar yang paling berguna adalah parameter fields. Parameter ini memungkinkan Anda memilih kolom dalam output yang ditampilkan yang ingin dilihat.

Misalnya, mencantumkan deskripsi untuk metrik yang diakhiri dengan utilization masih akan menampilkan banyak hasil. Jika hanya ingin mengetahui nama jenis metrik dan deskripsinya, Anda dapat menentukan pembatasan ini menggunakan parameter fields.

Untuk melihat hasil penetapan parameter fields, lakukan hal berikut:

1. Klik Coba!

2. Di parameter name, masukkan ID project menggunakan format projects/[PROJECT_ID]. Pastikan untuk mengganti [PROJECT_ID] dengan ID project Anda.

3. Pastikan parameter filter memiliki nilai metric.type=ends_with("utilization")

4. Klik Show standard parameter, dan pastikan parameter fields memiliki nilai metricDescriptors.type,metricDescriptors.description

5. Klik Execute dan selesaikan dialog otorisasi.

Mengeksekusi permintaan ini hanya akan menampilkan type (nama pendek) untuk setiap metrik dan description-nya.

Memecahkan masalah

Bagian ini menjelaskan masalah umum saat menggunakan APIs Explorer.

Untuk mengetahui informasi lebih lanjut tentang penggunaan Cloud Monitoring API, lihat Memecahkan masalah Cloud Monitoring API.

Sintaksis filter tidak valid

Anda menyalin ekspresi multibaris dan menempelkannya ke kolom yang ditampilkan di APIs Explorer, tetapi APIs Explorer akan menampilkan pesan error.

Lakukan: Pastikan string berada dalam satu baris.

"query": "fetch gce_instance::compute.googleapis.com/instance/disk/read_bytes_count | within 5m"

Jangan: Menyalin dan menempelkan kelanjutan baris atau karakter baris baru.

Misalnya, jika Anda menambahkan yang berikut ke metode timeSeries.query, APIs Explorer akan menampilkan pesan error Select an underlined section to see more details:

"query": "fetch gce_instance::compute.googleapis.com/instance/disk/read_bytes_count
          | within 5m"

ID project tidak valid

Jika ID project tidak valid, permintaan API akan gagal dengan error HTTP 400.

Untuk mengatasi kondisi ini, pastikan teks [PROJECT_ID] telah diganti dengan ID project Anda.

Nilai formulir tidak valid

Jika permintaan API Anda gagal atau menampilkan nilai yang tidak terduga, periksa semua parameter bentuk.

Parameter APIs Explorer memerlukan format tertentu. Kesalahan pemformatan dapat menyebabkan error atau mungkin diterima, tetapi diperlakukan seperti error ejaan dalam metode API:

• Jangan gunakan tanda kutip pada nilai parameter jenis apa pun.

• Jangan gunakan garis miring terbalik kecuali jika Anda perlu melindungi substring.

  Misalnya, contoh berikut adalah untuk metode API tempat Anda memasukkan konten sebagai JSON, bukan mengisi parameter formulir satu per satu. Karena nilai untuk filter adalah string, substring k8s_cluster dilindungi oleh garis miring terbalik:

    {
      "resourceNames": [...],
      "filter": "resource.type = \"k8s_cluster\""
    }

• String kutipan yang muncul di dalam filter. Gunakan tanda kutip ganda (") dan bukan apostrof ('). Untuk contoh, lihat Menyediakan parameter tambahan.

• Jangan gunakan encoding URL dalam formulir. Jika metode API memerlukan encoding URL, widget akan melakukan konversi saat Anda menjalankan metode tersebut.

Terlalu banyak data yang ditampilkan

Untuk membatasi jumlah hasil yang ditampilkan, di parameter pageSize, masukkan nilai, seperti 2. Parameter pageSize menentukan jumlah maksimum hasil yang ditampilkan, dan tersedia untuk sebagian besar metode API.

Untuk memilih kolom tertentu yang akan ditampilkan, gunakan parameter fields. Untuk mengetahui informasi selengkapnya, lihat Parameter standar.

Authentication

Ada bagian Credentials di halaman APIs Explorer. Sebaiknya biarkan kolom ini dalam nilai default. Mekanisme autentikasi default adalah Google OAuth 2.0.

Untuk mengetahui cakupan API yang diperlukan untuk metode ini, klik Show scope. Secara default, semua cakupan yang diperlukan telah diberikan.

Untuk informasi selengkapnya tentang konsep ini, lihat Mengontrol akses dengan Identity and Access Management.