API Gateway：Gunakan API Gateway untuk mengakses layanan backend di VPC

Prasyarat

• Lingkungan VPC telah dibuat. Untuk informasi lebih lanjut, lihat Buat VPC dengan blok CIDR IPv4 dan Buat VPC dengan blok CIDR IPv6.

• Instance Elastic Compute Service (ECS) telah dibuat. Untuk informasi lebih lanjut, lihat Langkah 1: Buat instance ECS.

Proses

Berikut adalah langkah-langkah keseluruhan untuk mengonfigurasi akses API Gateway ke layanan backend di VPC berdasarkan API:

• Buat otorisasi akses VPC

• Buat grup API

• Buat API

• Buat aplikasi dan otorisasi aplikasi untuk memanggil API

• Izinkan alamat IP keluar API Gateway dalam grup keamanan

• Debug API

• Panggil API

Buat otorisasi akses VPC

Untuk mengizinkan API Gateway mengakses VPC Anda, Anda harus terlebih dahulu membuat otorisasi akses VPC.

1. Masuk ke Konsol API Gateway. Di bilah navigasi atas, pilih wilayah. Di panel navigasi kiri, pilih Manage APIs > VPCs.

2. Di halaman VPC Access Authorizations, klik Create Authorization di pojok kanan atas.

3. Di kotak dialog Create VPC Access, tentukan parameter VPC Access Name, VPC Id, Instance ID or IP Address, dan Port Number.

   

   Catatan

   • Anda dapat menentukan nama domain di bidang Host untuk mengakses vhost pada instance SLB atau instance ECS.

   • Di ID VPC, masukkan ID VPC tempat layanan backend Anda berada. Di ID Instance atau Alamat IP, masukkan ID atau alamat IP privat dari instance tempat layanan backend Anda berada. Anda dapat memperoleh informasi tersebut di detail instance ECS.

Buat grup API

Buat API

1. Masuk ke Konsol API Gateway. Di bilah navigasi atas, pilih wilayah. Di panel navigasi kiri, pilih Manage APIs > API Groups.

2. Di halaman Group List, pada kolom Actions untuk grup nginx-demo yang telah Anda buat, klik API Management.

3. Di halaman APIs, klik Create API di pojok kanan atas.

4. Di langkah Basic Information dari wizard Create API, konfigurasikan parameter berikut dan klik Next.

   Parameter	Contoh
   Group	nginx-demo
   API Name	nginx-test
   Security Authentication	Alibaba Cloud App
   AppCode Authentication	Aktifkan Otentikasi AppCode (Header & Query)
   Signature Algorithm	HMAC_SHA256

   

5. Di langkah Define API Request, konfigurasikan parameter berikut dan klik Next.

   Parameter	Contoh
   Protocol	HTTP dan HTTPS
   Request Path	/nginx
   HTTP Method	GET
   Request Mode	Pass-through

   

   Catatan

   Di langkah ini, Anda mendefinisikan bagaimana klien, seperti browser web, aplikasi seluler, atau sistem bisnis, meminta API. Parameter yang perlu Anda konfigurasikan meliputi Protokol, Jalur Permintaan, Metode HTTP, Mode Permintaan, dan parameter di bagian Parameter Permintaan. Dalam contoh ini, Mode Permintaan disetel ke Pass-through, yang menunjukkan bahwa API Gateway langsung meneruskan permintaan API ke layanan backend di VPC tanpa memprosesnya.

6. Di langkah Define Backend Service, konfigurasikan parameter berikut dan klik Next.

   Parameter	Contoh
   Configuration Mode	Customize Backend Service
   Backend Service Type	VPC
   VPC Access Name	***-layanan mikro
   Backend Request Path	/
   HTTP Method	GET
   Backend Service Timeout Period	10000

   

   Catatan

   Di langkah ini, Anda mengonfigurasi tipe dan URL layanan backend ke mana API Gateway mengirimkan permintaan yang diterima dari klien dan bagaimana parameter permintaan dipetakan dan diproses. Dalam contoh ini, VPC ditentukan untuk Tipe Layanan Backend, otorisasi akses VPC yang Anda buat sebelumnya ditentukan untuk Nama Akses VPC, dan jalur ditentukan untuk Jalur Permintaan Backend.

7. Pada langkah Define Response, konfigurasikan parameter sesuai kebutuhan, lalu klik Create.

   

   Catatan

   Di langkah ini, Anda menentukan informasi respon untuk menghasilkan dokumentasi API. Dokumentasi membantu pemanggil API memahami API dengan lebih baik. Anda dapat mengatur parameter seperti Response ContentType, Response Example, dan Error Response Example. Contoh ini tidak mencakup langkah ini. Klik Create.

8. Di pesan yang muncul, klik Publish.

   

9. Di kotak dialog Publikasikan API yang muncul, atur Lingkungan ke Release, masukkan catatan di bagian Remarks, lalu klik Publish.

   

   Catatan

   Jika Anda memodifikasi API, modifikasi tersebut hanya berlaku setelah Anda mempublikasikan API ke lingkungan yang sesuai. API Gateway menyediakan tiga lingkungan tempat Anda dapat mempublikasikan API: Release, Pre, dan Test.

Buat aplikasi dan otorisasi aplikasi untuk memanggil API

Aplikasi adalah identitas yang Anda gunakan untuk memanggil API. Di langkah Buat API, tipe otentikasi disetel ke Alibaba Cloud App. Oleh karena itu, setelah Anda mempublikasikan API, Anda harus membuat dan mengotorisasi aplikasi untuk memanggil API.

Izinkan alamat IP keluar API Gateway dalam grup keamanan

Jika grup keamanan instance ECS Anda tidak mengizinkan semua blok CIDR melalui port tertentu, Anda harus menambahkan alamat IP keluar API Gateway ke grup keamanan untuk mengizinkan alamat IP tersebut. Alamat IP keluar API Gateway merujuk pada alamat IP keluar instance API Gateway tempat grup API berada.

1. Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > API Groups. Di halaman Grup API, klik nama grup API yang telah Anda buat.

2. Di halaman Group Details, lihat parameter Instance Type.

3. Di panel navigasi kiri, pilih Instances and Clusters > Instans Bersama atau Instans dan Klaster > Instans Spesifikasi Khusus berdasarkan jenis instans yang Anda peroleh. Di halaman yang muncul, gulir ke parameter Outbound Addresses instans berdasarkan ID instans untuk melihat alamat IP egress instans tersebut.

   

4. Masuk ke Konsol ECS. Di panel navigasi kiri, pilih Instances & Images > Instances. Klik instance ECS yang telah dibuat untuk membuka halaman detail. Klik tab Security Groups dan klik grup keamanan yang ingin Anda kelola. Di tab Security Group Details, klik tab Inbound, lalu klik Quick Add. Di kotak dialog Tambah Cepat, konfigurasikan alamat IP egress API Gateway.

   

Debug API

API Gateway mendukung debugging online. Kami sarankan Anda menggunakan fitur ini untuk memeriksa apakah API dikonfigurasi dengan benar sebelum Anda memanggil API ini di klien.

1. Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih Call APIs > Debug.

2. Di halaman Debug, pilih API nginx-test yang telah Anda buat, pilih Use AppCode sebagai Metode Autentikasi, lalu klik Send Request. Tanggapan yang ditunjukkan pada gambar berikut menunjukkan bahwa konfigurasi berhasil.

   

   Jika debugging gagal, lihat dokumen berikut:

   • Ikhtisar FAQ

   • Kode kesalahan

Panggil API

Untuk informasi lebih lanjut, lihat Pemanggilan API berbasis klien.