API Gateway:Konfigurasikan header Host

Cara kerja header Host

Header Host memberi tahu API Gateway ke aplikasi atau situs backend mana permintaan harus diteruskan ketika beberapa aplikasi berbagi IP server yang sama. Contoh umum:

• Layanan backend bertipe virtual private cloud (VPC), dan beberapa aplikasi atau situs dijalankan dalam VPC terkait. Header Host mengidentifikasi aplikasi mana yang akan menerima permintaan tersebut.

Kapan mengonfigurasi header Host: Hanya jika backend Anda menggunakan routing berbasis virtual host (beberapa aplikasi di balik satu IP). Jika backend Anda adalah server khusus, perilaku default biasanya sudah mencukupi—API Gateway mengatur header Host ke alamat backend yang telah Anda konfigurasi.

API Gateway menyediakan lima metode konfigurasi. Jika beberapa metode diaktifkan secara bersamaan, urutan prioritas berikut menentukan metode yang berlaku:

Konfigurasikan header Host

Pilih metode yang sesuai dengan pengaturan backend Anda dan ikuti langkah-langkah berikut.

Metode 1: Aktifkan Pass Host Header untuk kelompok API

Opsi ini meneruskan header Host asli dari klien ke backend, bukan menggunakan alamat backend yang telah Anda konfigurasi.

Perilaku default (Pass Host Header nonaktif):

Host: backend.test.com   ← API Gateway menggunakan alamat backend yang telah Anda konfigurasi

Dengan Pass Host Header aktif:

Host: apigateway.test.com   ← API Gateway meneruskan header Host asli dari client

Untuk mengaktifkannya:

1. Masuk ke Konsol API Gateway.

2. Di panel navigasi sebelah kiri, pilih API Management > API Groups.

3. Klik nama kelompok API target Anda.

4. Temukan sakelar Pass Host Header dan aktifkan.

Metode 2: Tambahkan parameter konstan host ke definisi API

Saat membuat API, tambahkan parameter konstan bernama host. Atur Parameter Location ke Head dan masukkan nama domain backend sebagai nilai parameter.

Metode 3: Konfigurasikan parameter Host untuk otorisasi akses VPC

1. Masuk ke Konsol API Gateway.

2. Di panel navigasi sebelah kiri, pilih API Management > VPC Access Authorizations.

3. Di pojok kanan atas, klik Create Authorization.

4. Pilih wilayah tempat VPC berada, lalu klik Create Authorization.

5. Di kotak dialog Create VPC Access Authorization, konfigurasikan parameter berikut:

   • Region

   • VPC Authorization Name: 4 hingga 50 karakter

   • VPC ID

   • Instance ID or Address: mendukung ID instans ECS atau SLB, IP privat, atau nama domain internal ALB

   • Port

   • Host: masukkan nilai header Host target

6. Klik OK.

Metode 4: Konfigurasikan host untuk layanan backend

1. Masuk ke Konsol API Gateway.

2. Di panel navigasi sebelah kiri, pilih Manage APIs > Backend Services.

3. Di pojok kanan atas, klik Create Backend Service dan buat layanan backend bertipe HTTP/HTTPS atau VPC. Hanya dua tipe ini yang mendukung konfigurasi host.

4. Setelah layanan backend dibuat, temukan di daftar dan klik Configure Backend Service and View Associated APIs di kolom Actions.

5. Di halaman Backend Service Definition, klik tab untuk lingkungan target Anda (misalnya, Test).

6. Klik Create di pojok kanan atas, lalu definisikan URL layanan backend dan bidang Host.

Bidang Host menetapkan header Host yang dikirim API Gateway saat meneruskan permintaan ke layanan backend ini.

Metode 5: Konfigurasikan header Host di plugin routing backend

Gunakan parameter httpTargetHostName atau vpcTargetHostName dalam plugin routing backend untuk mengatur header Host. Metode ini memiliki prioritas tertinggi dan menggantikan semua konfigurasi lainnya.

Untuk detail parameter dan sintaks konfigurasi, lihat bagian 1.3 pada Backend routing plug-ins.

Prioritas konfigurasi header Host

Jika Anda mengonfigurasi header Host menggunakan beberapa metode, konfigurasi tersebut berlaku berdasarkan urutan prioritas berikut: plugin routing backend > konfigurasi layanan backend > otorisasi akses VPC > konfigurasi kelompok API > definisi API.