Menggunakan API Explorer

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

API Explorer adalah cara yang sangat baik 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 memperluasnya 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Enable the Dataproc Metastore API.

    Enable the API

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Enable the Dataproc Metastore API.

    Enable the API

    6.

    Mengakses API Explorer

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

    Menjalankan permintaan minimal

    Sebagian besar metode memiliki beberapa parameter wajib dan beberapa parameter opsional. Kolom yang wajib diisi ditandai dengan batang merah hingga diisi. Anda dapat menjalankan permintaan minimal dengan hanya memberikan argumen yang diperlukan.

    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}. Sertakan ID layanan untuk serviceId.

    Cobalah!

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

    Jika header berwarna merah dan berisi kode kegagalan HTTP, kotak tersebut berisi pesan error. Lihat Tips untuk mendapatkan petunjuk tentang cara mengatasi error.

    Berikan parameter tambahan

    Daftar parameter yang Anda lihat bergantung pada metode yang digunakan untuk melampirkan widget API Explorer. Metode services.create memiliki lebih dari sekadar parameter parent dan serviceId, tetapi hanya parameter tersebut yang diperlukan.

    Anda dapat menggunakan parameter requestId opsional untuk menentukan ID permintaan unik agar 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 serangkaian kolom tambahan yang tidak tersedia melalui metode itu sendiri.

    Parameter ini disembunyikan di bawah tombol Tampilkan parameter standar.

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

    Parameter standar yang paling berguna adalah parameter fields, yang memungkinkan Anda memilih kolom dalam output yang ditampilkan yang ingin Anda lihat. Hal ini sangat berguna di panel API Explorer, tempat output ditampilkan dalam kotak. Sering kali ada banyak output yang harus di-scroll.

    Tips

    Bagian berikut berisi tips API Explorer.

    Jangan lupa untuk mengubah {projectNumber} and {locationId}

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

    Masalah terkait nilai

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

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

    URL bookmark untuk proses debug

    Setelah mendapatkan output yang diinginkan, beri bookmark pada URL API Explorer. Jika Anda ingin menjalankan metode lagi, tempelkan URL ke browser Anda. Anda akan melihat formulir yang sudah diisi dengan nilai Anda. Lakukan perubahan yang diperlukan pada parameter, lalu klik Jalankan untuk menjalankan metode lagi.

    Autentikasi

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

    Mekanisme autentikasi default adalah Google OAuth 2.0.

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

    Langkah berikutnya