Menggunakan API Explorer

Halaman ini menjelaskan cara menggunakan API Explorer untuk mencoba metode API Dataproc Metastore. API Explorer adalah widget yang dilampirkan ke halaman referensi REST API untuk suatu metode. Panel ini muncul sebagai panel dengan judul Coba API ini.

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

Anda juga dapat menyembunyikan widget dengan mengklik tombol tutup di bagian atas panel, atau meluaskannya ke layar penuh dengan mengklik tombol layar penuh.

Sebelum memulai

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  3. Aktifkan API Dataproc Metastore.

    Mengaktifkan API

    4.

  4. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  5. Aktifkan API Dataproc Metastore.

    Mengaktifkan API

    6.

Mengakses API Explorer

API Explorer dilampirkan ke halaman referensi untuk setiap metode REST API. Untuk menemukan widget, buka halaman referensi metode, misalnya, halaman referensi untuk Dataproc Metastore projects.locations.services.create.

Menjalankan permintaan minimal

Sebagian besar metode memiliki beberapa parameter yang diperlukan dan beberapa yang opsional. Metrik yang diperlukan ditandai dengan batang merah hingga diisi. Anda dapat menjalankan permintaan minimal dengan menyediakan argumen yang diperlukan saja.

Metode services.create membuat layanan Dataproc Metastore di project dan lokasi yang dipilih. Kolom yang wajib diisi adalah kolom parent dan serviceId. Untuk membuat layanan, berikan nomor project dan ID lokasi project Anda untuk parent menggunakan formulir projects/{projectNumber}/locations/{locationId}. Dan masukkan ID layanan untuk serviceId.

Cobalah!

Hasil pemanggilan metode muncul dalam kotak di bawah tombol Execute. Biasanya, kotak memiliki header hijau dengan kode status HTTP 200 di dalamnya, yang menunjukkan permintaan berhasil.

Jika header berwarna merah dan berisi kode kegagalan HTTP, kotak akan berisi pesan error. Lihat Tips untuk mendapatkan pointer tentang penyelesaian error.

Menyediakan parameter tambahan

Daftar parameter yang Anda lihat bergantung pada metode yang memasang widget API Explorer. Metode services.create memiliki lebih dari sekadar parameter parent dan serviceId, tetapi keduanya adalah satu-satunya parameter yang diperlukan.

Anda dapat menggunakan parameter requestId opsional untuk menentukan ID permintaan yang unik sehingga server dapat mengabaikan permintaan jika telah selesai.

Menggunakan kolom untuk membatasi output lebih lanjut

Secara default, kumpulan parameter yang ditampilkan API Explorer sesuai dengan parameter metode terkait. Namun, widget API Explorer juga memiliki sekumpulan kolom tambahan yang tidak tersedia melalui metode itu sendiri.

Parameter ini disembunyikan di bagian tombol Tampilkan parameter standar.

Klik tombol ini untuk menampilkan parameter widget tambahan. Klik Sembunyikan parameter standar untuk menyembunyikannya dari tampilan.

Yang paling berguna dari parameter standar ini adalah parameter fields, yang memungkinkan Anda memilih kolom dalam output yang ditampilkan yang ingin dilihat. Hal ini sangat berguna di panel API Explorer, tempat output ditampilkan dalam kotak. Sering kali ada banyak {i>output<i} yang harus di-scroll.

Tips

Bagian berikut berisi tips API Explorer.

Jangan lupa mengubah {projectNumber} and {locationId}

Jangan lupa untuk mengganti {projectNumber} and {locationId} dengan nomor dan ID lokasi project Anda. Perlu diperhatikan bahwa API juga menerima project ID sebagai pengganti angka.

Masalah dengan nilai

Berikut ini beberapa masalah yang harus diperhatikan saat menggunakan formulir API Explorer. Kesalahan ini dapat menyebabkan error atau mungkin diterima, tetapi akan diperlakukan seperti kesalahan ejaan dalam metode API:

  • Jangan gunakan tanda kutip pada nilai kolom jenis apa pun.
  • Pastikan untuk mengutip string yang muncul di dalam filter. Gunakan tanda kutip ganda (") dan bukan apostrof (').
  • Jangan gunakan garis miring terbalik atau encoding URL dalam kolom formulir. Jika diperlukan, encoding URL dilakukan pada nilai kolom saat Anda mengeksekusi metode.
  • Lihat nilai di kotak hasil setelah mengeksekusi panggilan. Anda mungkin memperhatikan masalah di sana.
  • Berikan nilai untuk kolom pageSize, seperti 2. Hal ini membatasi jumlah data yang ditampilkan saat Anda men-debug panggilan API.

Bookmark URL untuk proses debug

Setelah mendapatkan output yang Anda inginkan, bookmark URL API Explorer. Jika ingin menjalankan metode ini lagi, tempel URL-nya ke browser Anda. Anda melihat formulir sudah diisi dengan nilai Anda. Lakukan perubahan yang diperlukan pada parameter, lalu klik Execute untuk menjalankan metode ini lagi.

Authentication

Ada bagian Credentials di halaman API Explorer, di atas tombol Execute. Anda biasanya tidak perlu mengubah apa pun di sini.

Mekanisme autentikasi default adalah Google OAuth 2.0.

Ada juga tombol Tampilkan cakupan di bagian Kredensial. Opsi ini menunjukkan cakupan Compute Engine mana yang Anda miliki. Secara default, semua cakupan yang tersedia diaktifkan.

Langkah selanjutnya