Nama domain khusus untuk REST publik APIs di API Gateway

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Nama domain khusus lebih sederhana dan lebih intuitif URLs yang dapat Anda berikan kepada pengguna API Anda.

Setelah menerapkan API, Anda (dan pelanggan) dapat menjalankan API menggunakan URL dasar default dari format berikut:

https://api-id.execute-api.region.amazonaws.com/stage

dimana api-id dihasilkan oleh API Gateway, region adalah AWS Region, dan stage ditentukan oleh Anda saat menerapkan API.

Bagian nama host dari URL, api-id.execute-api.region.amazonaws.com mengacu pada titik akhir API. Nama endpoint API default dibuat secara acak, sulit diingat, dan tidak ramah pengguna.

Dengan nama domain khusus, Anda dapat mengatur nama host API Anda, dan memilih jalur dasar (misalnya,myservice) untuk memetakan URL alternatif ke API Anda. Misalnya, URL dasar API yang lebih ramah pengguna dapat menjadi:

https://api.example.com/myservice

Pertimbangan

Pertimbangan berikut dapat memengaruhi penggunaan nama domain kustom Anda.

Prasyarat untuk nama domain kustom

Berikut ini adalah prasyarat untuk membuat nama domain kustom publik atau pribadi. Untuk informasi tentang nama domain khusus untuk pribadi APIs, lihatNama domain khusus untuk pribadi APIs di API Gateway.

Daftarkan nama domain

Anda harus memiliki nama domain internet terdaftar untuk mengatur nama domain khusus untuk Anda APIs. Anda dapat mendaftarkan nama domain internet Anda menggunakan Amazon Route 53 atau menggunakan registrar domain pihak ketiga pilihan Anda. Nama domain kustom Anda dapat berupa nama subdomain atau domain root (juga dikenal sebagai “zone apex”) dari domain internet terdaftar.

Nama domain Anda harus mengikuti spesifikasi RFC 1035 dan dapat memiliki maksimum 63 oktet per label dan total 255 oktet.

Tentukan sertifikat untuk nama domain kustom Anda

Sebelum menyiapkan nama domain khusus untuk API, Anda harus memiliki sertifikat SSL/TLS yang siap di ACM. Jika ACM tidak tersedia di AWS Wilayah tempat Anda membuat nama domain kustom, Anda harus mengimpor sertifikat ke API Gateway di Wilayah tersebut.

Untuk mengimpor badan SSL/TLS certificate, you must provide the PEM-formatted SSL/TLS sertifikat, kunci pribadinya, dan rantai sertifikat untuk nama domain kustom.

Setiap sertifikat yang disimpan dalam ACM diidentifikasi oleh ARN-nya. Dengan sertifikat yang dikeluarkan oleh ACM, Anda tidak perlu khawatir mengekspos detail sertifikat sensitif, seperti kunci pribadi. Untuk menggunakan sertifikat AWS terkelola untuk nama domain, Anda cukup mereferensikan ARN-nya.

Jika aplikasi Anda menggunakan pinning sertifikat, kadang-kadang dikenal sebagai penyematan SSL, untuk menyematkan sertifikat ACM, aplikasi mungkin tidak dapat terhubung ke domain Anda setelah AWS memperbarui sertifikat. Untuk informasi selengkapnya, lihat Masalah penyematan sertifikat di Panduan AWS Certificate Manager Pengguna.

Nama domain kustom wildcard

Dengan nama domain khusus wildcard, Anda dapat mendukung jumlah nama domain yang hampir tak terbatas tanpa melebihi kuota default. Misalnya, Anda bisa memberi setiap pelanggan Anda nama domain mereka sendiricustomername.api.example.com.

Untuk membuat nama domain kustom wildcard, tentukan wildcard (*) sebagai subdomain pertama dari domain kustom yang mewakili semua kemungkinan subdomain dari domain root.

Misalnya, nama domain kustom wildcard *.example.com menghasilkan subdomain sepertia.example.com,, dan b.example.comc.example.com, yang semuanya merutekan ke domain yang sama.

Nama domain kustom wildcard mendukung konfigurasi yang berbeda dari nama domain kustom standar API Gateway. Misalnya, dalam satu AWS akun, Anda dapat mengkonfigurasi *.example.com dan a.example.com berperilaku berbeda.

Anda dapat menggunakan variabel $context.domainName dan $context.domainPrefix konteks untuk menentukan nama domain yang digunakan klien untuk memanggil API Anda. Untuk mempelajari lebih lanjut tentang variabel konteks, lihatTemplate pemetaan API Gateway dan referensi variabel pencatatan akses.

Untuk membuat nama domain kustom wildcard, Anda harus memberikan sertifikat yang dikeluarkan oleh ACM yang telah divalidasi menggunakan DNS atau metode validasi email.

Langkah selanjutnya untuk nama domain kustom

Berikut ini adalah langkah selanjutnya untuk nama domain kustom:

Jika ini adalah pertama kalinya Anda membuat nama domain kustom, kami sarankan Anda mulai denganSiapkan sertifikat AWS Certificate Manager, untuk menentukan sertifikat Anda, dan kemudian Menyiapkan nama domain kustom Regional di API Gateway membuat nama domain kustom Regional.