Siapkan nama domain kustom yang dioptimalkan tepi di Gateway API - APIGerbang Amazon
PertimbanganBuat nama domain kustom yang dioptimalkan tepiBuat DNS catatan untuk nama domain kustom yang dioptimalkan tepi AndaLog pembuatan nama domain kustom di CloudTrailKonfigurasikan pemetaan jalur dasar API dengan nama domain kustom sebagai nama hostnyaPutar sertifikat yang diimpor ke ACMHubungi Anda API dengan nama domain khusus

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

Siapkan nama domain kustom yang dioptimalkan tepi di Gateway API

Saat Anda membuat nama domain khusus untuk yang dioptimalkan tepiAPI, API Gateway menyiapkan CloudFront distribusi dan DNS catatan untuk memetakan nama API domain ke nama domain CloudFront distribusi. Permintaan untuk kemudian API dirutekan ke API Gateway melalui distribusi yang dipetakan CloudFront . Pemetaan ini adalah untuk API permintaan yang terikat untuk nama domain kustom yang akan dirutekan ke API Gateway melalui distribusi yang CloudFront dipetakan.

Pertimbangan

Berikut ini adalah pertimbangan untuk nama domain kustom yang dioptimalkan tepi Anda.

  • Untuk menyiapkan nama domain kustom yang dioptimalkan tepi atau memperbarui sertifikatnya, Anda harus memiliki izin untuk memperbarui CloudFront distribusi.

    Izin berikut diperlukan untuk memperbarui CloudFront distribusi: 

    {
    "Version": "2012-10-17",
    "Statement": [
         {
            "Sid": "AllowCloudFrontUpdateDistribution",
            "Effect": "Allow",
            "Action": [
                "cloudfront:updateDistribution"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

  • Anda harus meminta atau mengimpor sertifikat untuk nama domain kustom yang dioptimalkan tepi Anda di Wilayah AS Timur (Virginia N.). us-east-1

  • CloudFront Distribusi yang dibuat oleh API Gateway dimiliki oleh akun khusus Wilayah yang berafiliasi dengan Gateway. API Saat melacak operasi untuk membuat dan memperbarui CloudFront distribusi seperti itu CloudTrail, Anda harus menggunakan ID akun API Gateway ini. Untuk informasi selengkapnya, lihat Log pembuatan nama domain kustom di CloudTrail.

  • APIGateway mendukung nama domain kustom yang dioptimalkan tepi dengan memanfaatkan Server Name Indication (SNI) pada distribusi. CloudFront Untuk informasi selengkapnya tentang penggunaan nama domain khusus pada CloudFront distribusi, termasuk format sertifikat yang diperlukan dan ukuran maksimum panjang kunci sertifikat, lihat Menggunakan Nama Domain Alternatif dan HTTPS di Panduan CloudFront Pengembang Amazon

  • Nama domain kustom yang dioptimalkan tepi membutuhkan waktu sekitar 40 menit untuk siap.

  • Setelah membuat nama domain kustom yang dioptimalkan tepi, Anda harus membuat DNS catatan untuk memetakan nama domain kustom ke nama CloudFront distribusi.

Buat nama domain kustom yang dioptimalkan tepi

Prosedur berikut menjelaskan cara membuat nama domain kustom yang dioptimalkan tepi untuk. API

AWS Management Console

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Pilih Nama domain khusus dari panel navigasi utama.

  3. Pilih Buat.

  4. Untuk nama Domain, masukkan nama domain.

  5. Untuk TLSversi Minimum, pilih versi.

  6. Di bawah konfigurasi Endpoint, untuk tipe API endpoint, pilih Edge-optimized.

  7. Untuk ACMsertifikat, pilih ACM sertifikat.

  8. Pilih Buat nama domain.

REST API

  1. Panggil domainname:create, dengan menentukan nama domain kustom dan sertifikat yang disimpan di. ARN AWS Certificate Manager

    APIPanggilan yang berhasil mengembalikan 201 Created respons yang berisi sertifikat ARN serta nama CloudFront distribusi terkait dalam muatannya.

  2. Perhatikan nama domain CloudFront distribusi yang ditunjukkan pada output. Anda memerlukannya di langkah berikutnya untuk mengatur CNAME nilai domain kustom atau target alias A-record di Anda. DNS

Untuk contoh kode REST API panggilan ini, lihat domainname:create.

Nama domain khusus yang dioptimalkan tepi membutuhkan waktu sekitar 40 menit untuk siap, tetapi konsol segera menampilkan nama domain CloudFront distribusi terkait, dalam bentukdistribution-id.cloudfront.net, bersama dengan sertifikat. ARN Sementara itu, Anda dapat melanjutkan ke langkah berikutnya dan mengonfigurasi alias DNS catatan untuk memetakan nama domain kustom ke nama domain CloudFront distribusi terkait.

Buat DNS catatan untuk nama domain kustom yang dioptimalkan tepi Anda

Setelah Anda memulai pembuatan nama domain kustom yang dioptimalkan tepi, siapkan alias rekaman. DNS

Kami menyarankan Anda menggunakan Route 53 untuk membuat alias A-record untuk nama domain kustom Anda dan menentukan nama domain CloudFront distribusi sebagai target alias. Ini berarti bahwa Route 53 dapat merutekan nama domain kustom Anda meskipun itu adalah puncak zona. Untuk informasi selengkapnya, lihat Memilih Antara Kumpulan Rekaman Sumber Daya Alias dan Non-Alias di Panduan Pengembang Amazon Route 53.

Sebagai gantinya, Anda dapat menambahkan domain kustom Anda ke zona yang dihosting sebagai kumpulan catatan CNAME sumber daya. Nama CNAME rekaman menentukan nama domain kustom yang Anda masukkan sebelumnya di Nama Domain (misalnya,api.example.com). Nilai CNAME record menentukan nama domain untuk CloudFront distribusi.

Namun, penggunaan CNAME catatan tidak akan berfungsi jika domain kustom Anda adalah puncak zona (yaitu, example.com bukanapi.example.com). Apex zona juga dikenal sebagai domain root organisasi Anda. Untuk puncak zona, Anda perlu menggunakan alias A-record, asalkan didukung oleh penyedia Anda. DNS

Untuk petunjuk tentang Amazon Route 53, lihat Merutekan lalu lintas ke Amazon API Gateway API menggunakan nama domain Anda di Panduan Pengembang Amazon Route 53.

Log pembuatan nama domain kustom di CloudTrail

Saat CloudTrail diaktifkan untuk mencatat panggilan API Gateway yang dilakukan oleh akun Anda, API Gateway mencatat pembaruan CloudFront distribusi terkait saat nama domain khusus dibuat atau diperbarui untuk fileAPI. Log ini tersedia dius-east-1. Karena CloudFront distribusi ini dimiliki oleh API Gateway, masing-masing CloudFront distribusi yang dilaporkan diidentifikasi oleh salah satu akun API Gateway khusus Wilayah berikutIDs, bukan ID akun API pemilik.

Wilayah

ID Akun
us-east-1 392220576650
us-east-2 718770453195
us-west-1 968246515281
us-west-2 109351309407
ca-central-1 796887884028
eu-west-1 631144002099
eu-west-2 544388816663
eu-west-3 061510835048
eu-central-1 474240146802
eu-central-2 166639821150
eu-north-1 394634713161
eu-south-1 753362059629
eu-south-2 359345898052
ap-northeast-1 969236854626
ap-northeast-2 020402002396
ap-northeast-3 360671645888
ap-southeast-1 195145609632
ap-southeast-2 798376113853
ap-southeast-3 652364314486
ap-southeast-4 849137399833
ap-south-1 507069717855
ap-south-2 644042651268
ap-east-1 174803364771
sa-east-1 287228555773
me-south-1 855739686837
me-central-1 614065512851

Konfigurasikan pemetaan jalur dasar API dengan nama domain kustom sebagai nama hostnya

Anda dapat menggunakan pemetaan jalur dasar untuk menggunakan satu nama domain kustom sebagai nama host dari beberapa. APIs Ini membuat API dapat diakses melalui kombinasi nama domain kustom dan jalur dasar terkait.

Misalnya, jika di API Gateway, Anda membuat API nama PetStore dan API nama lain Dogs dan kemudian mengatur nama domain kustomapi.example.com, Anda dapat mengatur PetStore API's URL sebagaihttps://api.example.com.

Ini mengaitkan PetStore API dengan jalur dasar string kosong. Jika Anda menetapkan PetStore API's URL ashttps://api.example.com/PetStore, ini mengaitkan PetStore API dengan jalur dasar. PetStore Anda dapat menetapkan jalur dasar MyDogList untuk. Dogs API URLDari https://api.example.com/MyDogList kemudian menjadi akar URL dari DogsAPI.

Untuk mengonfigurasi API pemetaan pada beberapa tingkatan, Anda hanya dapat menggunakan nama domain kustom Regional. Nama domain kustom yang dioptimalkan tepi tidak didukung. Untuk informasi selengkapnya, lihat Memetakan API tahapan ke nama domain khusus untuk REST APIs.

Prosedur berikut mengatur API pemetaan untuk memetakan jalur dari nama domain kustom Anda ke tahapan AndaAPI.

AWS Management Console

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Pilih Nama domain khusus dari panel navigasi utama konsol API Gateway.

  3. Pilih nama domain khusus.

  4. Pilih Konfigurasi API pemetaan.

  5. Pilih Tambahkan pemetaan baru.

  6. Tentukan API, Tahap, dan Jalur (opsional) untuk pemetaan.

  7. Pilih Simpan.

REST API

Panggil basepathmapping:create pada nama domain kustom tertentu, tentukan propertirestApiId, dan deployment dalam basePath payload permintaan. stage

APIPanggilan yang berhasil mengembalikan 201 Created respons.

Untuk contoh kode REST API panggilan, lihat basepathmapping:create.

Putar sertifikat yang diimpor ke ACM

ACMsecara otomatis menangani pembaruan sertifikat yang dikeluarkannya. Anda tidak perlu memutar sertifikat ACM yang diterbitkan untuk nama domain kustom Anda. CloudFront menanganinya atas nama Anda.

Namun, jika Anda mengimpor sertifikat ke dalam ACM dan menggunakannya untuk nama domain khusus, Anda harus memutar sertifikat sebelum kedaluwarsa. Ini melibatkan mengimpor sertifikat pihak ketiga baru untuk nama domain dan memutar sertifikat yang ada ke yang baru. Anda perlu mengulangi proses ketika sertifikat yang baru diimpor kedaluwarsa. Atau, Anda dapat meminta ACM untuk mengeluarkan sertifikat baru untuk nama domain dan memutar yang sudah ada ke sertifikat baru ACM yang diterbitkan. Setelah itu, Anda dapat meninggalkan ACM dan CloudFront menangani rotasi sertifikat untuk Anda secara otomatis. Untuk membuat atau mengimpor ACM sertifikat baru, ikuti langkah-langkahnyaUntuk membuat atau mengimpor TLS sertifikatSSL/ke ACM.

Prosedur berikut menjelaskan cara memutar sertifikat untuk nama domain.

catatan

Dibutuhkan sekitar 40 menit untuk memutar sertifikat yang diimporACM.

AWS Management Console

  1. Meminta atau mengimpor sertifikat diACM.

  2. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  3. Pilih Nama domain khusus dari panel navigasi utama konsol API Gateway.

  4. Pilih nama domain khusus.

  5. Pilih Edit.

  6. Pilih sertifikat yang diinginkan dari daftar dropdown ACMsertifikat.

  7. Pilih Simpan untuk mulai memutar sertifikat untuk nama domain kustom.

  8. Setelah rotasi selesai, Anda dapat memilih ikon panah dua arah di sebelah ACMSertifikat untuk memutar kembali ke sertifikat asli.

REST API

Panggil domainname:update action, yang menentukan ACM sertifikat baru untuk ARN nama domain yang ditentukan.

Hubungi Anda API dengan nama domain khusus

Memanggil API dengan nama domain khusus sama dengan memanggil API dengan nama domain defaultnya, asalkan yang benar URL digunakan.

Contoh berikut membandingkan dan membedakan satu set default URLs dan kustom yang sesuai URLs dari dua APIs (udxjefdanqf3duz) di Region tertentu (us-east-1), dan nama domain kustom yang diberikan (api.example.com).

APIID Stage Default URL Jalur dasar Kustom URL
udxjef prod https://udxjef.execute-api.us-east-1.amazonaws.com/prod /toko hewan peliharaan https://api.example.com/toko hewan peliharaan
udxjef tst https://udxjef.execute-api.us-east-1.amazonaws.com/tst /petdepot https://api.example.com/petdepot
qf3duz dev https://qf3duz.execute-api.us-east-1.amazonaws.com/dev /toko buku https://api.example.com/toko buku
qf3duz tst https://qf3duz.execute-api.us-east-1.amazonaws.com/tst /rak buku https://api.example.com/rak buku

APIGateway mendukung nama domain khusus untuk API dengan menggunakan Server Name Indication (SNI). Anda dapat memanggil API dengan nama domain khusus menggunakan browser atau pustaka klien yang mendukungSNI.

APIGateway memberlakukan SNI CloudFront distribusi. Untuk informasi tentang cara CloudFront menggunakan nama domain khusus, lihat CloudFront Kustom Amazon SSL.