Panggil API melalui nama domain HTTPS - API Gateway

Ketika API Gateway menerima permintaan API, sistem menemukan grup API unik berdasarkan nama domain tujuan dan mengidentifikasi API spesifik dalam grup tersebut menggunakan path serta metode HTTP dari permintaan. Anda dapat mengaitkan nama domain HTTPS dengan grup API di konsol API Gateway dan mengunggah sertifikat SSL untuk nama domain tersebut. Dengan konfigurasi ini, Anda dapat memanggil API dalam grup melalui nama domain HTTPS.

Catatan Penggunaan

Nama domain independen yang ingin dikaitkan ke grup API harus memenuhi persyaratan berikut:

Untuk mengaitkan nama domain independen ke grup API di wilayah daratan Tiongkok, Anda harus mendaftarkan nomor ICP di Sistem Pendaftaran ICP Alibaba Cloud atau menambahkan Alibaba Cloud sebagai penyedia layanan pada informasi pendaftaran ICP nama domain tersebut.
Sebelum mengaitkan nama domain independen ke grup API, tambahkan catatan CNAME untuk memetakan nama domain independen ke nama domain tingkat dua dari grup API.
Nama domain independen yang ingin dikaitkan tidak boleh sudah terkait dengan grup API lain di API Gateway oleh pengguna lain. Jika nama domain telah dikaitkan oleh pengguna lain, verifikasi diperlukan saat mencoba mengaitkannya. Untuk memanggil API melalui HTTPS, Anda harus mengunggah sertifikat SSL untuk nama domain tersebut.

Penting

Secara default, API Gateway menyediakan nama domain tingkat dua publik untuk setiap grup API. Saat klien menggunakan nama domain tingkat dua publik untuk memanggil API, jumlah panggilan harian dibatasi: 100 panggilan di wilayah Hong Kong, Tiongkok, dan luar daratan Tiongkok, serta 1.000 panggilan di wilayah daratan Tiongkok. Untuk lingkungan produksi, Anda harus mengaitkan nama domain independen ke grup API. Nama domain independen tidak memiliki batasan jumlah panggilan.

Prosedur

Berikut adalah langkah-langkah untuk mengaitkan nama domain HTTPS ke grup API di konsol API Gateway dan mengunggah sertifikat SSL untuk nama domain tersebut.

Resolusi nama domain: Tambahkan catatan CNAME atau TXT untuk memetakan nama domain independen (publik atau internal) ke nama domain tingkat dua (publik atau internal) yang disediakan oleh grup API. Untuk detail lebih lanjut, lihat Resolusi nama domain.
- Resolusi nama domain publik: Gunakan Alibaba Cloud DNS (DNS) untuk memetakan nama domain publik Anda ke nama domain tingkat dua publik yang disediakan oleh API Gateway untuk grup API. Untuk detail lebih lanjut, lihat Resolusi nama domain publik.
- Resolusi nama domain internal: Gunakan Alibaba Cloud DNS untuk memetakan nama domain internal Anda ke nama domain tingkat dua internal yang disediakan oleh API Gateway untuk grup API. Untuk detail lebih lanjut, lihat Resolusi nama domain internal.
Pengikatan nama domain: Di halaman Detail Grup konsol API Gateway, kaitkan nama domain independen Anda ke grup API. Untuk detail lebih lanjut, lihat Pengikatan nama domain.
Unggah sertifikat SSL: Konfigurasikan sertifikat SSL untuk nama domain agar Anda dapat memanggil API melalui HTTPS. Untuk detail lebih lanjut, lihat Unggah sertifikat SSL.

Resolusi nama domain

Resolusi nama domain publik

Masuk ke konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > API Groups, lalu pilih wilayah.
Di halaman API Groups, klik grup API yang ingin dikelola untuk membuka halaman detail. Di bagian Basic Information, temukan nama domain tingkat dua publik yang disediakan oleh API Gateway untuk grup API.
Masuk ke konsol DNS. Di panel navigasi kiri, pilih Public DNS > Authoritative DNS Resolution. Di halaman Resolusi DNS Otoritatif, klik tab Authoritative Domain Names. Klik nama domain yang diinginkan untuk membuka tab DNS Settings.
Di tab DNS Settings, klik Add DNS Record. Di kotak dialog yang muncul, atur Record Type ke CNAME, Hostname ke awalan nama domain, dan Record Value ke nama domain tingkat dua publik. Lalu, klik OK.

Resolusi nama domain internal

Masuk ke konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > API Groups, lalu pilih wilayah.
Di halaman API Groups, klik grup API yang ingin dikelola untuk membuka halaman detail. Di bagian Basic Information, temukan nama domain virtual private cloud (VPC) internal yang disediakan oleh API Gateway untuk grup API.
Masuk ke konsol DNS. Di panel navigasi kiri, klik Private DNS (PrivateZone). Di bagian kanan atas halaman Private DNS (PrivateZone), klik Configuration Mode. . Di tab User Defined Zones, klik Add New Zone.
Di panel Add Built-in Authoritative Zone, tentukan Built-in Authoritative Zone dan Alibaba Cloud VPC, lalu klik OK.
Catatan
Untuk parameter Built-in Authoritative Zone, masukkan nama domain khusus (internal) yang terkait dengan grup API. Nama domain ini didedikasikan untuk private DNS (PrivateZone) di VPC.
Klik zona otoritatif bawaan untuk membuka tab Resource Records Settings. Klik Add Record untuk menambahkan catatan CNAME untuk nama domain internal. Di panel Add Record, atur Record Type ke CNAME, Hostname ke awalan nama domain, dan Record Value ke nama domain VPC internal. Lalu, klik OK.

Catatan

Di instance Elastic Compute Service (ECS) yang diterapkan di VPC terkait dengan zona privat, rekaman zona privat akan menimpa rekaman DNS publik.
Di VPC, rekaman DNS publik zona privat tidak terpengaruh. Anda dapat menambahkan rekaman DNS untuk zona privat Anda untuk mencegah zona privat yang rekaman DNS-nya kosong menimpa rekaman DNS publik. Jika tidak, kesalahan resolusi DNS akan terjadi. Untuk informasi lebih lanjut, lihat Aktivasi Alibaba Cloud DNS PrivateZone.

Pengikatan nama domain

Masuk ke konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > API Groups, lalu pilih wilayah.
Di halaman API Groups, klik grup API yang ingin dikaitkan dengan nama domain untuk membuka halaman Group Details. Di bagian Independent Domains, klik Bind Domain Name.

Di kotak dialog Bind Domain Name, konfigurasikan parameter yang diperlukan dan klik Confirm.

Parameter	Deskripsi
Nama Domain	Masukkan nama domain yang akan diikat ke grup API.
Lingkungan	Lingkungan yang terkait dengan nama domain. Nilai valid: Test: Anda hanya dapat memanggil API di lingkungan pengujian. Pre: Anda hanya dapat memanggil API di lingkungan staging. Produksi: Anda hanya dapat memanggil API di lingkungan produksi. Default (X-Ca-Stage): Anda dapat memanggil semua API di lingkungan sebelumnya. Saat Anda memanggil API, tambahkan parameter X-Ca-Stage ke header permintaan Anda untuk menentukan lingkungan di mana Anda ingin memanggil API.
Tipe Jaringan	Internet: Anda hanya dapat memanggil API melalui Internet. Jaringan Internal: Anda hanya dapat memanggil API melalui jaringan internal.

Catatan

Anda tidak perlu memverifikasi kepemilikan nama domain internal. Jika nama domain bertentangan dengan nama domain yang terkait dengan grup API lain dalam instance yang sama, nama domain gagal dikaitkan dengan grup API.
Setelah nama domain dikaitkan dengan grup API, Anda tidak dapat mengubah tipe jaringan nama domain tersebut. Jika konfigurasi salah, Anda dapat menghapus nama domain dan mengaitkannya kembali ke grup API.

FAQ tentang pengikatan nama domain

Apa yang harus saya lakukan jika nama domain gagal diikat ke grup API?

Nama domain yang ingin dikaitkan sudah terkait dengan grup API lain dalam instance saat ini, atau rentangnya bertentangan dengan nama domain lain yang telah dikaitkan. Konflik rentang merujuk pada nama domain wildcard yang menimpa nama domain tunggal. Dalam kasus ini, lepaskan nama domain sebelum mengaitkan nama domain saat ini.
Nama domain yang ingin dikaitkan sudah terkait dengan grup API yang dibuat oleh pengguna lain, atau rentangnya bertentangan dengan nama domain lain yang telah dikaitkan. Konflik rentang merujuk pada nama domain wildcard yang menimpa nama domain tunggal. Dalam kasus ini, verifikasi kepemilikan nama domain dengan mengikuti instruksi di bagian Verifikasi Kepemilikan Nama Domain sebelum mengaitkan nama domain saat ini.

Unggah sertifikat SSL

Setelah nama domain dikaitkan dengan grup API, Anda dapat menggunakan nama domain untuk memanggil semua API dalam grup melalui HTTP. Untuk memanggil API melalui HTTPS, Anda harus mengunggah sertifikat SSL untuk nama domain. API Gateway menyediakan metode berikut untuk mengunggah sertifikat SSL: 1. API Gateway secara otomatis mengimpor sertifikat SSL dari Layanan Manajemen Sertifikat Alibaba Cloud. 2. API Gateway memungkinkan Anda mengunggah sertifikat SSL yang diperoleh dari penyedia layanan sertifikat lain secara manual.

Buat sertifikat SSL

Untuk membuat sertifikat SSL gratis menggunakan Layanan Manajemen Sertifikat Alibaba Cloud, ikuti langkah-langkah berikut:

Masuk ke konsol Sertifikat SSL Alibaba Cloud.
Di halaman pembelian sertifikat, beli sertifikat dan kaitkan dengan nama domain. Untuk informasi lebih lanjut, lihat Memulai dengan Layanan Sertifikat SSL. Setelah mengajukan sertifikat SSL, masuk ke halaman Detail Grup dari grup API di konsol API Gateway.

Impor atau unggah sertifikat SSL

Setelah membeli atau menyiapkan sertifikat SSL, impor atau unggah sertifikat untuk nama domain yang dikaitkan dengan grup API di konsol API Gateway. Berikut adalah prosedur untuk mengimpor dan mengunggah sertifikat SSL.

Impor sertifikat SSL

Jika Anda membeli sertifikat menggunakan Layanan Manajemen Sertifikat Alibaba Cloud, ikuti langkah-langkah berikut untuk mengimpor sertifikat untuk nama domain yang dikaitkan dengan grup API di API Gateway:

Masuk ke konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > API Groups, lalu pilih wilayah.
Di halaman API Groups, klik grup API yang diinginkan untuk membuka halaman Group Details. Di bagian Independent Domains, temukan nama domain yang ingin dikaitkan. Klik Select Certificate di kolom SSL Certificate.
Di kotak dialog Select Certificate, klik Search for Certificate. Pilih sertifikat yang diperlukan dari hasil pencarian dan klik Synchronize Certificate.

Unggah sertifikat SSL

Jika sertifikat SSL Anda tidak dibeli dari Alibaba Cloud, Anda dapat mengunggah sertifikat ke API Gateway. Ikuti langkah-langkah berikut untuk mengunggah sertifikat SSL:

Masuk ke konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > API Groups, lalu pilih wilayah.
Di halaman API Groups, klik grup API yang diinginkan untuk membuka halaman Group Details. Di bagian Independent Domains, temukan nama domain yang ingin dikaitkan. Klik Select Certificate di kolom SSL Certificate.
Dalam kotak dialog Select Certificate, klik Add Certificate.
Di kotak dialog Create Certificate, masukkan dan unggah isi sertifikat sesuai petunjuk, lalu klik Confirm.
Setelah sertifikat diunggah, masuk ke halaman Detail Grup. Anda akan melihat bahwa tautan Pilih Sertifikat dari nama domain di bagian Independent Domains berubah menjadi Independent Domains. Setelah sertifikat diunggah, Anda dapat menggunakan nama domain untuk memanggil API melalui HTTPS.