Buat instans Gerbang API Cloud Native - API Gateway - Alibaba Cloud Documentation Center

Instans Cloud-native API Gateway menyediakan eksposur layanan, manajemen lalu lintas, perlindungan keamanan, dan pengelolaan siklus hidup penuh untuk API Anda. Topik ini menjelaskan cara membuat instans Cloud-native API Gateway di Konsol, serta cara mengaktifkan akselerasi perangkat keras Gzip dan pengiriman log gateway saat pembuatan instans tersebut.

Prasyarat

Otorisasi peran terkait layanan — Saat pertama kali mengaktifkan Cloud-native API Gateway, Anda harus memberikan kebijakan akses sistem berikut:
- AliyunServiceRoleForNativeApiGw: Memberikan akses ke layanan Alibaba Cloud lainnya, seperti ACK, VPC, SLB, dan MSE.
- AliyunServiceRolePolicyForNativeApiGwInvokeFC: Memberikan akses ke Function Compute (FC).
Wilayah — Buat gateway di wilayah yang sama dengan layanan backend Anda.
VPC dan vSwitch — VPC yang sudah ada tempat layanan Anda berjalan, dan vSwitch untuk node gateway. Gateway harus berjalan di VPC yang sama dengan layanan Anda.

Penting

Anda tidak dapat mengubah wilayah setelah instans dibuat. Akselerasi perangkat keras Gzip harus dipilih di halaman pembelian dan tidak dapat diaktifkan pada instans yang sudah ada.

Konfigurasi dasar

Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi kiri, pilih Instance. Di halaman instans, klik Instance Creation.
Di halaman pembelian Cloud-native API Gateway, konfigurasikan parameter berikut:
- Product Type: Pilih Pay-as-you-go atau Subscription. Detail harga untuk setiap metode penagihan dijelaskan dalam Billing overview.
  - Pay-as-you-go — Anda dikenai biaya per jam. Penggunaan kurang dari satu jam ditagih sebagai satu jam penuh. Tagihan diselesaikan setiap jam.
  - Subscription — Anda dikenai biaya per bulan. Langganan satu tahun ditagih sebagai 12 bulan.
- Region: Pilih wilayah tempat gateway berjalan. Untuk batasan wilayah, lihat Prasyarat.
- Gateway Name: Masukkan nama kustom untuk gateway. Sebagai praktik terbaik, beri nama gateway sesuai lingkungan atau gabungkan lingkungan dan domain bisnis, misalnya test atau order-prod. Nama dapat memiliki panjang hingga 64 karakter.
- GatewaySpec: Lakukan penilaian kapasitas berdasarkan kebutuhan bisnis Anda, lalu pilih spesifikasi node. Untuk ambang batas setiap spesifikasi, lihat Capacity thresholds for different node specifications.
  - Gateway yang berjalan pada node tunggal tidak menyediakan SLA. Untuk workload produksi, pilih spesifikasi yang menerapkan beberapa node.
  - Untuk menggunakan akselerasi perangkat keras Gzip, pilih apigw.medium.x1 atau spesifikasi yang lebih tinggi.
- Resource Group: Pilih kelompok sumber daya yang sudah ada atau kelompok sumber daya default. Kelompok sumber daya memungkinkan Anda mengklasifikasikan dan mengelompokkan sumber daya Akun Alibaba Cloud Anda, sehingga Anda dapat menangani pengelolaan izin, penerapan sumber daya, dan pemantauan sumber daya untuk seluruh kelompok, bukan per sumber daya. Untuk membuat kelompok sumber daya, klik Create Resource Group.
- Network Type: Pilih Internet, Private Network, atau Public + Private. Jika klien hanya mengakses gateway melalui jaringan pribadi, pilih Private untuk menghindari biaya traffic jaringan publik.
  - Internet — Saat gateway diakses melalui jaringan publik, biaya traffic jaringan publik berlaku. Traffic jaringan publik ditagih dan difaktur melalui Cloud Data Transfer (CDT) dalam mode BGP (multi-line), sebagaimana dijelaskan dalam Public network traffic.
  - Private Network — Tidak ada biaya traffic untuk akses jaringan pribadi.
  - Public + Private — Saat gateway diakses melalui jaringan publik, biaya traffic jaringan publik berlaku. Traffic jaringan publik ditagih dan difaktur melalui Cloud Data Transfer (CDT) dalam mode BGP (multi-line). Tidak ada biaya traffic untuk akses jaringan pribadi.
- VPC: Pilih VPC tempat instans gateway berjalan. VPC gateway harus sama dengan VPC layanan Anda.
- Zone Selection: Pilih Auto-assign atau Manual Select.
  - Auto-assign — Pilih vSwitches untuk node gateway. Sistem secara otomatis menetapkan dua zona untuk node gateway.
  - Manual Select — Pilih secara manual Zone dan vSwitches untuk node gateway. Pilih opsi ini jika node gateway harus berjalan di zona tertentu, seperti zona yang mendukung akselerasi perangkat keras Gzip.
Klik Buy Now. Di halaman Confirm Order, periksa detail konfigurasi instans Cloud-native API Gateway, lalu klik Open now.
Catatan
Pembuatan instans gateway memerlukan waktu 1 hingga 5 menit.
Di halaman Instance Cloud-native API Gateway, periksa status instans gateway yang telah Anda buat. Status Running menunjukkan bahwa gateway telah berhasil dibuat.

Capacity thresholds for different node specifications

Tabel berikut mencantumkan ambang batas kapasitas untuk setiap GatewaySpec Cloud-native API Gateway. Saat metrik kapasitas gateway tetap di bawah ambang peringatan, gateway dilindungi oleh SLA penuh. Untuk bisnis inti, pertahankan metrik kapasitas di bawah ambang aman agar stabilitas lebih baik.

Ambang aman — Gateway mempertahankan throughput tinggi dan latensi rendah bahkan ketika traffic tiba-tiba meningkat dua kali lipat.
Ambang peringatan — Saat kapasitas melebihi ambang peringatan, latensi gateway dapat meningkat, dan risiko ketidakstabilan dapat terjadi selama lonjakan traffic.
Gateway node tunggal — Gateway yang berjalan pada node tunggal tidak menyediakan SLA dan hanya ditujukan untuk skenario pengujian. Untuk workload produksi, gunakan GatewaySpec yang menerapkan beberapa node.

Spesifikasi gateway	Koneksi klien		Koneksi HTTPS baru		Penggunaan CPU		Penggunaan memori
Spesifikasi gateway	Ambang aman	Ambang peringatan	Ambang aman	Ambang peringatan	Ambang Batas Aman	Ambang peringatan	Ambang Batas Keamanan	Ambang peringatan
`apigw.dev.x1`	12.000	24.000	400	800	30%	60%	75%	75%
`apigw.small.x1`	24.000	48.000	800	1.600	30%	60%	75%	75%
`apigw.small.x2`	48.000	96.000	1.600	3.200	30%	60%	75%	75%
`apigw.small.x4`	96.000	192.000	3.200	6.400	30%	60%	75%	75%
`apigw.medium.x1`	192.000	384.000	6.400	12.800	30%	60%	75%	75%
`apigw.medium.x2`	384.000	768.000	12.800	25.600	30%	60%	75%	75%
`apigw.medium.x3`	576.000	1.152.000	19.200	38.400	30%	60%	75%	75%
`apigw.large.x1`	768.000	1.536.000	25.600	51.200	30%	60%	75%	75%
`apigw.large.x2`	1.536.000	3.072.000	51.200	102.400	30%	60%	75%	75%
`apigw.large.x3`	2.304.000	4.608.000	76.800	153.600	30%	60%	75%	75%
`apigw.large.x4`	3.072.000	6.144.000	102.400	204.800	30%	60%	75%	75%

Fitur lanjutan

Saat membuat instans Cloud-native API Gateway, gunakan konfigurasi berikut untuk memantau dan menganalisis data log, atau untuk mengompresi permintaan dan respons guna mengurangi traffic gateway. Akselerasi perangkat keras Gzip hanya tersedia jika Anda memilihnya di halaman pembelian. Simple Log Service (SLS) tidak memiliki batasan tersebut.

Aktifkan akselerasi perangkat keras Gzip

Akselerasi perangkat keras Gzip menggunakan perangkat keras khusus untuk mengompresi dan mendekompresi data dengan cepat. Memindahkan proses dekompresi Gzip dari CPU ke perangkat keras khusus meningkatkan efisiensi pemrosesan dan mengurangi beban CPU.

Pengaktifan fitur ini terdiri dari dua tahap. Opsi yang Anda pilih di halaman pembelian menentukan apakah instans dapat menggunakan akselerasi perangkat keras Gzip, dan Anda tidak dapat menambahkan kemampuan ini ke instans yang sudah ada. Setelah instans dibuat, Anda mengontrol fitur ini melalui parameter EnableGzipHardwareAccelerate.

Untuk mengonfigurasi akselerasi perangkat keras Gzip di halaman pembelian

Di halaman pembelian Cloud-native API Gateway, lengkapi konfigurasi dasar dan konfigurasi berikut, lalu klik Open now:
- Region: Akselerasi perangkat keras Gzip tersedia di China (Hangzhou), China (Beijing), China (Shanghai), China (Shenzhen), China (Ulanqab), China (Hong Kong), dan Singapura.
  Catatan
  Beberapa zona di wilayah yang didukung tidak mendukung fitur ini. Halaman pembelian menampilkan zona yang benar-benar tersedia.
- GatewaySpec: Pilih apigw.medium.x1 atau spesifikasi yang lebih tinggi.
- Gzip Hardware Acceleration: Pilih opsi ini untuk mengaktifkan akselerasi perangkat keras Gzip.
Jika Gzip Hardware Acceleration tidak tersedia di halaman pembelian, periksa apakah GatewaySpec adalah apigw.medium.x1 atau lebih tinggi dan apakah zona yang dipilih mendukung fitur tersebut.

Contoh

Contoh berikut menunjukkan konfigurasi halaman pembelian yang memenuhi persyaratan akselerasi perangkat keras Gzip. Untuk kapasitas setiap spesifikasi, lihat Capacity thresholds for different node specifications.

Untuk GatewaySpec, pilih apigw.medium.x1. Untuk Resource Group, pilih Default Resource Group. Untuk Network Type, pilih Internet. Untuk VPC, pilih VPC target. Untuk Zone Selection, klik Manual Select, pilih Hangzhou Zone J dan Hangzhou Zone K (keduanya mendukung akselerasi perangkat keras Gzip), lalu pilih vSwitch untuk setiap zona.

Untuk mengaktifkan akselerasi perangkat keras Gzip setelah instans dibuat

Setelah instans dibuat, klik ID atau nama instans target. Di panel navigasi kiri, pilih Parameters. Di bagian Gateway Engine Parameters, edit parameter EnableGzipHardwareAccelerate.
Penting
Jika Anda tidak memilih Gzip Hardware Acceleration saat membeli instans, Anda tidak dapat mengaktifkan parameter ini.
Verifikasi bahwa nilai saat ini dari EnableGzipHardwareAccelerate di halaman Parameters sesuai dengan nilai yang Anda tetapkan.
Setelah fitur diaktifkan, klien harus mampu memproses data terkompresi Gzip. Untuk klien yang mendukung Gzip, tambahkan header permintaan Accept-Encoding: gzip.

Aktifkan pengiriman log gateway

Untuk mengumpulkan, menyimpan, dan menganalisis log runtime gateway, aktifkan Simple Log Service (SLS) saat membuat instans gateway. Anda kemudian dapat menggunakan SLS untuk analisis log dan pemantauan Dasbor.

Saat melengkapi konfigurasi dasar, pilih Use Simple Log Service (SLS). Sistem akan mengaktifkan Simple Log Service (SLS) dan mengaktifkan pengiriman log gateway.
Setelah pengiriman log diaktifkan, verifikasi bahwa log gateway muncul di Observation and Analysis > Logs.
Untuk makna setiap field log, lihat Gateway log fields.

Referensi

Referensi performa Gzip

Berapa banyak traffic yang dihemat oleh kompresi Gzip? Dengan kompresi Gzip, rasio kompresi—yaitu ukuran data terkompresi dibagi ukuran data asli—sangat bergantung pada data itu sendiri. Rasio kompresi yang lebih rendah berarti kompresi lebih baik, sedangkan rasio kompresi yang lebih tinggi berarti kompresi kurang efektif.

Secara umum, Gzip lebih efektif mengompresi data yang mengandung banyak pola atau struktur berulang, seperti huruf, kata, dan tanda baca dalam teks, sehingga menghasilkan rasio kompresi yang lebih rendah. Untuk data dengan tingkat keacakan dan entropi tinggi, seperti gambar, video, dan file terkompresi, pengulangan internal rendah, sehingga rasio kompresi biasanya lebih tinggi dan kompresi kurang efektif.

Rasio kompresi sangat bervariasi antar pelanggan karena perbedaan data bisnis mereka. Statistik untuk instans yang mengaktifkan Gzip di wilayah inti menunjukkan bahwa sebagian besar instans memiliki rasio kompresi antara 10% hingga 50%. Rata-rata, pengguna ini menghemat lebih dari 50% traffic setelah mengaktifkan Gzip.

Gambar berikut menunjukkan rasio kompresi yang diukur pada instans yang mengaktifkan Gzip di wilayah inti.

Compression ratios measured on Cloud-native API Gateway instances with Gzip enabled in core regions

Berapa banyak sumber daya instans yang dihemat oleh akselerasi perangkat keras saat Gzip sudah diaktifkan? Setelah akselerasi perangkat keras Gzip diaktifkan, gateway mengompresi data pada perangkat keras khusus dan menghemat sumber daya CPU. Data uji stres berikut membandingkan penggunaan CPU antara instans node tunggal dengan akselerasi perangkat keras Gzip dan instans empat node yang menggunakan Gzip berbasis perangkat lunak, saat keduanya melayani QPS yang sama.

Sebagai contoh, data terkompresi adalah file teks JSON sekitar 120 KB:

QPS	Penggunaan CPU: Gzip akselerasi perangkat keras/apigw.medium.x1/node tunggal	Penggunaan CPU: software Gzip/apigw.medium.x1/4 node
2.000	9%	11%
5.000	26%	28%
10.000	56%	56%
13.000	69%	72%

Tabel menunjukkan bahwa penggunaan CPU untuk akselerasi perangkat keras Gzip/node tunggal kira-kira sama dengan penggunaan CPU untuk Gzip perangkat lunak/4 node. Beban kerja yang sebelumnya memerlukan 4 node dapat berjalan pada 1 node setelah Anda mengaktifkan akselerasi perangkat keras Gzip, sehingga menghemat sekitar 75% sumber daya instans.

Field log gateway

Tabel berikut menjelaskan field-field dalam log yang dikirimkan Cloud-native API Gateway ke Simple Log Service (SLS).

Field	Tipe	Deskripsi
__time__	long	Waktu saat log dihasilkan.
cluster_id	string	ID instans AI Gateway.
ai_log	json	Objek JSON yang berisi field log untuk Model API, Agent API, dan MCP API. Field ini kosong untuk jenis API lainnya. api: Nama AI API. cache_status: Menunjukkan apakah permintaan terkena cache saat caching konten diaktifkan untuk Model API. consumer: Identitas konsumen. Field ini diisi saat autentikasi konsumen diaktifkan. fallback_from: Rute asal permintaan dialihkan. Field ini diisi saat kebijakan fallback diaktifkan untuk Model API. input_token: Jumlah token input dalam permintaan LLM. llm_first_token_duration: Waktu hingga token pertama (TTFT) untuk permintaan LLM. llm_service_duration: Waktu respons end-to-end untuk permintaan LLM. model: Nama model yang digunakan dalam permintaan LLM. output_token: Jumlah token output dalam respons LLM. response_type: Jenis respons permintaan LLM, seperti streaming atau non-streaming. safecheck_status: Hasil Moderasi Konten untuk permintaan LLM. token_ratelimit_status: Menunjukkan apakah permintaan diblokir oleh pembatasan laju berbasis token.
authority	string	Nilai header Host dalam permintaan.
bytes_received	long	Ukuran badan permintaan dalam byte, tidak termasuk header.
bytes_sent	long	Ukuran badan respons dalam byte, tidak termasuk header.
downstream_local_address	string	Alamat pod gateway.
downstream_remote_address	string	Alamat klien yang terhubung ke gateway.
duration	long	Total waktu pemrosesan permintaan dalam milidetik, diukur dari saat gateway menerima byte pertama dari klien hingga mengirim byte terakhir respons.
method	string	Metode HTTP.
path	string	Jalur dalam permintaan HTTP.
protocol	string	Versi protokol HTTP.
request_duration	long	Waktu dalam milidetik dari saat gateway menerima byte pertama permintaan dari klien hingga menerima byte terakhir.
request_id	string	ID unik yang dihasilkan gateway untuk setiap permintaan. ID ini disertakan dalam header `x-request-id`. Anda dapat menggunakan field ini untuk mencatat dan memecahkan masalah permintaan.
requested_server_name	string	Nama server yang digunakan untuk koneksi SSL.
response_code_details	string	Konteks tambahan untuk kode respons. Misalnya, `via_upstream` menunjukkan layanan backend mengembalikan kode respons, dan `route_not_found` menunjukkan gateway tidak menemukan rute yang cocok.
response_tx_duration	long	Waktu dalam milidetik dari saat gateway menerima byte pertama dari layanan upstream hingga mengirim byte terakhir ke klien.
route_name	string	Nama rute.
start_time	string	Waktu mulai permintaan. Waktu dalam UTC.
trace_id	string	ID jejak.
upstream_cluster	string	Kluster upstream.
upstream_host	string	Alamat IP host upstream.
upstream_local_address	string	Alamat lokal yang digunakan untuk terhubung ke layanan upstream.
upstream_service_time	long	Waktu pemrosesan permintaan dalam milidetik untuk layanan upstream. Durasi ini mencakup latensi jaringan dan waktu pemrosesan layanan itu sendiri.
upstream_transport_failure_reason	string	Alasan kegagalan koneksi upstream.
user_agent	string	Nilai header User-Agent dalam permintaan.
x_forwarded_for	string	Nilai header `x-forwarded-for`, yang biasanya berisi alamat IP asli klien.

Langkah selanjutnya

Cloud-native API Gateway mendukung berbagai jenis API, termasuk REST API, HTTP API, dan WebSocket API. Anda dapat mengonfigurasi aturan routing atau kebijakan untuk setiap jenis API.
Saat Anda membuat layanan, layanan backend ditambahkan ke gateway, dan gateway memperoleh serta mengelola titik akhir layanan backend secara terpusat.
Untuk mengekspos layanan internal ke luar dengan mengonfigurasi rute gateway, lihat Use an HTTP API to access applications in Container Service for Kubernetes (ACK).
Jika Anda mengalami masalah saat menggunakan Cloud-native API Gateway, lihat FAQ.