Menyediakan hub API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Topik ini menjelaskan cara menyediakan API hub menggunakan UI Apigee di konsol Google Cloud. Ini adalah metode yang direkomendasikan untuk menyediakan API hub. Gambar 1 menyoroti langkah-langkah dasar yang dijelaskan dalam dokumen penyediaan ini.

Gambar 1. Langkah-langkah untuk menyediakan instance hub Apigee API.

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Make sure that you have the following role or roles on the project:

   • roles/serviceusage.serviceUsageAdmin
   • roles/cloudkms.admin
   • roles/apihub.provisioningAdmin
   • roles/resourcemanager.projectIamAdmin

   Check for the roles

   1. In the Google Cloud console, go to the IAM page.

      Go to IAM
   2. Select the project.

   3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

   4. For all rows that specify or include you, check the Role colunn to see whether the list of roles includes the required roles.

   Grant the roles

   1. In the Google Cloud console, go to the IAM page.

      Buka IAM
   2. Pilih project.
   3. Klik Berikan akses.

   4. Di kolom New principals, masukkan ID pengguna Anda. Ini biasanya adalah alamat email untuk Akun Google.

   5. Di daftar Pilih peran, pilih peran.
   6. Untuk memberikan peran tambahan, klik Tambahkan peran lain, lalu tambahkan setiap peran tambahan.
   7. Klik Simpan.

   Ringkasan langkah

   Langkah-langkah penyediaannya adalah sebagai berikut:

   1. Langkah 1: Aktifkan API. Apigee mengharuskan Anda mengaktifkan beberapa Google Cloud API.
   2. Langkah 2: Pilih lokasi hosting. Tentukan lokasi fisik hub API Anda.
   3. Langkah 3: Daftarkan project host. Project Google Cloud saat ini dipilih secara default.
   4. Langkah 4. Konfigurasi enkripsi. Pilih atau buat kunci enkripsi yang dikelola pelanggan (CMEK) atau gunakan kunci enkripsi yang dikelola Google (GMEK) untuk mengenkripsi dan mendekripsi data API Anda dalam penyimpanan.
   5. Langkah 5: Buat identitas layanan. Tetapkan izin akses ke identitas layanan.
   6. Buat instance hub API Anda. Penyediaan memerlukan waktu beberapa menit hingga selesai.

   Langkah-langkah penyediaan

   Untuk meluncurkan penyediaan untuk API Hub:

   1. Pastikan Anda telah memenuhi prasyarat yang dijelaskan di Sebelum memulai.

   2. Di konsol Google Cloud, buka halaman sambutan hub Apigee API.

      Buka hub Apigee API

   3. Klik Create instance.
      • Jika API Hub tidak disediakan di organisasi Anda, UI akan menampilkan Langkah 1 alur kerja penyediaan.
      • Jika API hub telah disediakan, Anda akan diarahkan ke halaman referensi API.

   Langkah 1: API

   Untuk menyediakan API hub, Anda harus mengaktifkan API berikut untuk project Google Cloud Anda:

   Nama API	Lokasi	Deskripsi
   API hub API	apihub.googleapis.com	API hub API.
   Cloud Key Management Service (KMS)	cloudkms.googleapis.com	Mengelola kunci dan melakukan operasi kriptografis untuk digunakan langsung oleh resource Cloud lainnya.

   Untuk mengaktifkan API yang diperlukan, klik Aktifkan API. Langkah ini memerlukan waktu beberapa detik hingga selesai.

   Langkah 2: Lokasi

   Anda perlu memilih dua lokasi: Pertama, lokasi fisik (region) tempat Anda ingin menghosting instance hub Apigee API, dan kedua, multi-region tempat data penelusuran Vertex AI Anda akan disimpan:

   1. Dari menu drop-down, pilih region tempat Anda ingin menghosting instance hub API. Lokasi yang didukung meliputi:

      Deskripsi region	Nama region
      Iowa	us-central1
      Northern Virginia	us-east4
      Oregon	us-west1
      Belgia	europe-west1
      London	europe-west2
      Singapura	asia-southeast1
      Mumbai	asia-south1
      Sao Paulo	southamerica-east1
      Sydney	australia-southeast1

   2. Jika opsi Aktifkan kemampuan penelusuran Vertex diaktifkan (default), Anda harus memilih lokasi multi-region tempat menyimpan data penelusuran berbasis Vertex AI, data yang terkait dengan fitur Semantic Search di API hub. Secara default, multi-region yang menyertakan region API hub yang Anda tetapkan di Langkah 1 akan dipilih. Misalnya, jika Anda memilih us-central1 sebagai region API hub, us multi-region akan dipilih secara default. Namun, Anda bebas beralih ke multi-region lain jika mau.

      Opsi penelusuran Vertex mengaktifkan fitur Penelusuran Semantik yang didukung Vertex AI di hub API. Jika Anda membatalkan pilihan opsi Aktifkan kemampuan penelusuran Vertex, Penelusuran Semantik akan dinonaktifkan, dan pemilih multi-region akan disembunyikan.

   Catatan: Jika dipilih, opsi penelusuran Vertex akan otomatis menyediakan Vertex AI di region Google Cloud yang ada dalam multi-region yang sama dengan region tempat API hub dihosting. Misalnya, jika Anda memilih us-central1 sebagai region hosting untuk API hub, Vertex dapat disediakan di region mana pun dalam multi-region us. Misalnya, Vertex dapat disediakan di us-west1, us-west2, us-central2, atau region lain di dalam multi-region US.
   3. Klik Tetapkan lokasi.

   Langkah 3: Daftarkan project host

   Project host adalah project Google Cloud di organisasi Apigee yang Anda tetapkan sebagai project konsumen untuk semua resource API hub. Satu instance API hub dapat disediakan per project host.

   Untuk menggunakan project Google Cloud organisasi Apigee Anda sebagai project host untuk API Hub, klik Register.

   Langkah 4: Enkripsi

   Pada langkah ini, Anda dapat memilih untuk menggunakan kunci enkripsi yang dikelola Google (GMEK) atau Kunci Enkripsi yang Dikelola Pelanggan (CMEK) yang ditentukan di Cloud Key Management Service untuk mengenkripsi data yang disimpan di instance API hub Anda.

   Untuk menggunakan kunci enkripsi yang dikelola Google, cukup pilih opsi Kunci enkripsi yang dikelola Google. Jika Anda memilih opsi ini, tidak diperlukan konfigurasi kunci lebih lanjut.

   Untuk menggunakan CMEK yang ada:

   1. Di kotak Choose a customer-managed encryption key (CMEK), ketik untuk memfilter atau scroll untuk menelusuri kunci yang ada. Atau, Anda dapat memasukkan ID resource kunci untuk menemukan kunci yang ada.
   2. Pilih kunci Anda, lalu klik OK.
   3. Klik Konfirmasi.

   Untuk membuat CMEK baru:

   1. Klik Create key. Dialog Create a new key akan ditampilkan.
   2. Di bagian Key ring, Anda dapat menentukan key ring yang ada atau membuat key ring baru.
      • Untuk menggunakan ring kunci yang ada:
        1. Pilih key ring yang ada dari daftar Key ring.
        2. Klik Lanjutkan.
      • Untuk membuat keyring baru:
        1. Klik tombol Create key ring atau klik Create key ring di kotak pilih.
        2. Di kolom Key ring name, masukkan nama untuk key ring Anda.

           Nama key ring dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Key ring tidak dapat diganti namanya atau dihapus.

        3. Pilih lokasi dari daftar Key ring location.

           Lokasi ini dibatasi untuk lokasi hosting yang Anda pilih di langkah sebelumnya untuk memastikan kunci dan data tetap berada di region yang sama.

        4. Klik Lanjutkan.
   3. Di bagian Kunci:
      1. Masukkan nama untuk kunci Anda di kolom Key name.

         Nama kunci dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Kunci tidak dapat diganti namanya atau dihapus.

      2. Pilih Tingkat perlindungan, misalnya, Software.
      3. Klik Lanjutkan.
   4. Di bagian Tinjau, konfirmasi detail yang Anda tentukan untuk pembuatan kunci.

      Jika informasi sudah benar, klik Create.

      Peringatan: Kunci dan key ring tidak dapat dihapus setelah dibuat. Untuk mempelajari lebih lanjut, lihat Mengapa saya tidak dapat menghapus kunci atau ring kunci?.
   5. Pilih kunci yang baru dibuat di kotak Choose a customer-managed encryption key.
   6. Klik Konfirmasi kunci enkripsi.

   Langkah 5: Identitas layanan

   Pada langkah ini, Anda akan membuat identitas layanan baru dan memberinya akses ke kunci enkripsi yang dikelola pelanggan yang dipilih. Kunci ini digunakan untuk mengenkripsi dan mendekripsi data API hub Anda.

   Untuk membuat identitas layanan baru, klik Buat identitas layanan & berikan izin.

   Apigee membuat akun layanan dan menetapkan peran cloudkms.cryptoKeyEncrypterDecrypter, apihub.admin, dan apihub.runtimeProjectServiceAgent ke akun layanan.

   Membuat instance hub API

   Klik Kirim untuk membuat instance API hub.

   Saat penyediaan dimulai, halaman Menyelesaikan instance API hub akan ditampilkan. Langkah ini memerlukan waktu beberapa menit hingga selesai.

   Setelah penyediaan selesai, halaman API di API Hub akan ditampilkan.

   Catatan: Jika Anda telah menyediakan API hub di project yang memiliki proxy Apigee, proxy tersebut akan otomatis terdaftar di API hub dalam beberapa jam setelah menyediakan API hub. Misalnya, jika Anda menyediakan API hub di test-project-1, dan project ini memiliki proxy Apigee, test-project-1 akan otomatis dilampirkan sebagai project runtime, dan proxy di test-project-1 akan terdaftar di API hub.

   Langkah selanjutnya

   Selamat! Anda telah berhasil menyediakan API hub.

   Sekarang, Anda siap untuk mulai menggunakan API hub:

   • Tinjau peran dan izin yang diperlukan untuk menggunakan API Hub
   • Konfigurasikan atribut hub API:
     • Mengelola atribut
     • Panduan memulai: Membuat dan mengedit atribut
   • Mendaftarkan resource API:
     • Mengelola resource API
     • Panduan memulai: Mendaftarkan API
   • Menambahkan versi API:
     • Ringkasan versi
     • Panduan memulai: Membuat versi API