Menggunakan APIs Explorer

Panduan ini menjelaskan cara menggunakan APIs Explorer untuk mencoba metode Cloud Monitoring API. API Explorer adalah widget yang dilampirkan ke halaman referensi REST API untuk suatu metode. Panel ini akan muncul dengan judul Coba API ini. Screenshot berikut menampilkan panel saat muncul untuk metode dengan hanya satu parameter, name:

API Explorer adalah cara yang sangat baik 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 Jalankan, dan lihat hasilnya.

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

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

Tombol Coba!

Dalam dokumentasi, Anda mungkin melihat tombol Coba seperti berikut:

Cobalah!

Saat Anda mengklik tombol, API Explorer di halaman referensi metode akan terbuka. Biasanya, beberapa parameter yang sesuai dengan contoh akan diisi; namun, Anda mungkin harus mengedit beberapa parameter agar sesuai 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 wajib dan beberapa parameter opsional. Kolom yang wajib diisi ditandai dengan batang merah hingga diisi. Anda dapat mengeksekusi permintaan setelah memberikan nilai untuk semua argumen yang diperlukan.

Metode metricDescriptors.list menampilkan deskriptor untuk semua jenis metrik yang tersedia dalam 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 Anda 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. Jika diminta, pilih akun, lalu klik Izinkan. Akses berlaku untuk jangka waktu terbatas dan dibatasi untuk metode API yang Anda jalankan.

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

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

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

Berikan parameter tambahan

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

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

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

1. Klik Coba!

2. Di parameter name, masukkan ID project Anda 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 API Explorer sesuai dengan parameter metode terkait. Namun, widget API Explorer juga memiliki serangkaian 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 Anda lihat.

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

Untuk melihat hasil penyetelan parameter fields, lakukan hal berikut:

1. Klik Coba!

2. Di parameter name, masukkan ID project Anda 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 Tampilkan parameter standar, dan pastikan parameter fields memiliki nilai metricDescriptors.type,metricDescriptors.description

5. Klik Execute dan selesaikan dialog otorisasi.

Menjalankan permintaan ini hanya akan menampilkan type (nama singkat) setiap metrik dan description-nya.

Memecahkan masalah

Bagian ini menjelaskan masalah umum saat menggunakan API Explorer.

Untuk mengetahui informasi selengkapnya tentang cara menggunakan Cloud Monitoring API, lihat Memecahkan masalah Cloud Monitoring API.

Sintaksis filter tidak valid

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

Lakukan: Pastikan string berada dalam satu baris.

"query": "sum by (instance_name) (rate({\"compute.googleapis.com/instance/disk/read_bytes_count\", monitored_resource=\"gce_instance\"}[5m]))"

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

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

"query": "sum by (instance_name) (
                   rate(
                      {\"compute.googleapis.com/instance/disk/read_bytes_count\",
                          monitored_resource=\"gce_instance\"
                     }[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] diganti dengan ID project Anda.

Nilai formulir tidak valid

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

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

• Jangan gunakan tanda kutip di sekitar nilai parameter dari jenis apa pun.

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

  Misalnya, contoh berikut adalah untuk metode API yang memungkinkan Anda memasukkan konten sebagai JSON, bukan melengkapi 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 petik ganda ("), bukan apostrof ('). Untuk melihat contohnya, lihat bagian Menyediakan parameter tambahan.

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

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.

Autentikasi

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

Untuk mengetahui cakupan API yang diperlukan untuk metode tersebut, klik Show scopes. Secara default, semua cakupan yang diperlukan akan diberikan.

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