Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Siapkan nama domain kustom Regional di API Gateway
Gunakan nama domain kustom Regional untuk membuat basis yang ramah penggunaAPI. URL Dengan nama domain kustom Regional, Anda dapat memetakan HTTP dan REST API tahapan ke nama domain kustom yang sama dan menggunakan TLS otentikasi timbal balik.
Pertimbangan
Berikut ini adalah pertimbangan untuk nama domain kustom Regional Anda.
-
Anda harus memberikan sertifikat khusus WilayahACM. Sertifikat ini harus berada di Wilayah yang sama dengan AndaAPI. Untuk informasi selengkapnya tentang membuat atau mengunggah sertifikat nama domain kustom, lihatSiapkan sertifikat AWS Certificate Manager.
-
Saat Anda membuat nama domain kustom Regional (atau memigrasikan satu) dengan ACM sertifikat, API Gateway akan membuat peran terkait layanan di akun Anda. Peran terkait layanan diperlukan untuk melampirkan ACM sertifikat Anda ke titik akhir Regional Anda. Peran tersebut diberi nama AWSServiceRoleForAPIGatewaydan akan memiliki kebijakan APIGatewayServiceRolePolicyterkelola yang melekat padanya. Untuk informasi selengkapnya tentang penggunaan peran terkait layanan, lihat Menggunakan Peran Tertaut Layanan.
-
Setelah Anda membuat nama domain kustom Regional Anda, Anda harus membuat DNS catatan tipe “A” untuk mengarahkan nama domain kustom ke nama domain Regional. Ini memungkinkan lalu lintas yang terikat ke nama domain kustom untuk dialihkan ke nama host Regional. API
Buat nama domain kustom Regional
Prosedur berikut menunjukkan cara membuat nama domain kustom Regional. Setelah Anda menyelesaikan prosedur ini, Anda harus membuat DNS catatan untuk mengarahkan nama domain kustom ke nama domain Regional.
- AWS Management Console
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.
-
Pilih Nama domain khusus dari panel navigasi utama.
-
Pilih Buat.
-
Untuk nama Domain, masukkan nama domain.
-
Untuk TLSversi Minimum, pilih versi.
-
Di bawah konfigurasi Endpoint, untuk tipe API endpoint, pilih Regional.
-
Pilih ACM sertifikat. Sertifikat harus berada di Wilayah yang sama denganAPI.
-
Pilih Buat.
- AWS CLI
-
create-domain-namePerintah berikut dapat digunakan untuk membuat nama domain kustom:
aws apigatewayv2 create-domain-name \
--domain-name 'regional.example.com' \
--domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678
Jika berhasil, panggilan mengembalikan hasil yang mirip dengan berikut ini:
{
"ApiMappingSelectionExpression": "$request.basepath",
"DomainName": "regional.example.com",
"DomainNameConfigurations": [
{
"ApiGatewayDomainName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com",
"CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
"DomainNameStatus": "AVAILABLE",
"EndpointType": "REGIONAL",
"HostedZoneId": "Z2OJLYMUO9EFXC",
"SecurityPolicy": "TLS_1_2"
}
]
}
Nilai DomainNameConfigurations properti mengembalikan nama host RegionalAPI. Anda harus membuat DNS catatan untuk mengarahkan nama domain kustom Anda ke nama domain Regional ini. Ini memungkinkan lalu lintas yang terikat ke nama domain kustom untuk diarahkan ke nama host Regional API ini.
Buat DNS catatan untuk nama domain kustom Regional Anda
Prosedur berikut menunjukkan cara membuat DNS catatan untuk mengarahkan nama domain kustom Anda nama domain Regional yang baru dibuat.
- AWS Management Console
Untuk menggunakan AWS Management Console, ikuti dokumentasi Route 53 tentang mengonfigurasi Route 53 untuk merutekan lalu lintas ke API Gateway.
- AWS CLI
Untuk mengonfigurasi DNS catatan Anda untuk memetakan nama domain kustom Regional ke nama hostnya dari ID zona host yang diberikan, pertama-tama buat JSON file yang berisi konfigurasi untuk menyiapkan DNS catatan untuk nama domain Regional.
Berikut ini setup-dns-record.json menunjukkan cara membuat DNS A catatan untuk memetakan nama domain kustom Regional (regional.example.com) ke nama host Regional (d-numh1z56v6.execute-api.us-west-2.amazonaws.com) yang disediakan sebagai bagian dari pembuatan nama domain kustom. HostedZoneIdProperti DNSName dan AliasTarget dapat mengambil regionalHostedZoneId nilai regionalDomainName dan, masing-masing, dari nama domain kustom. Anda juga bisa mendapatkan Regional Route 53 Hosted Zone IDs di Amazon API Gateway Endpoints dan Quotas.
{
"Changes": [
{
"Action": "CREATE",
"ResourceRecordSet": {
"Name": "regional.example.com",
"Type": "A",
"AliasTarget": {
"DNSName": "d-numh1z56v6.execute-api.us-west-2.amazonaws.com",
"HostedZoneId": "Z2OJLYMUO9EFXC",
"EvaluateTargetHealth": false
}
}
}
]
}
Berikut ini change-resource-record-setsmenunjukkan cara membuat DNS catatan untuk nama domain kustom Regional Anda:
aws route53 change-resource-record-sets \
--hosted-zone-id Z2OJLYMUO9EFXC \
--change-batch file://path/to/your/setup-dns-record.json
Ganti hosted-zone-id dengan ID Zona Dihosting Route 53 dari DNS catatan yang ditetapkan di akun Anda. Nilai change-batch parameter menunjuk ke JSON file (setup-dns-record.json) dalam folder (path/to/your).
Buat pemetaan jalur dasar untuk nama domain kustom Regional Anda
Setelah Anda membuat DNS catatan, Anda membuat pemetaan jalur dasar untuk memetakan Anda API ke nama domain kustom. Misalnya, Anda dapat memetakan tahap test untuk API ID abc123 ke nama domain kustom regional.example.com menggunakan kunci API pemetaan. myApi Ini memetakan API https://abcd1234.execute-api.us-west-2.amazonaws.com/test kehttps://regional.example.com/myApi.
- AWS Management Console
-
- AWS CLI
create-api-mappingPerintah berikut dapat digunakan untuk membuat pemetaan jalur dasar:
aws apigatewayv2 create-api-mapping \
--domain-name 'regional.example.com' \
--api-mapping-key 'myApi' \
--api-id abcd1234 \
--stage 'test'
Akibatnya, basis yang URL menggunakan nama domain khusus untuk API yang digunakan di panggung menjadihttps://regional.example.com/myAPI.
Dengan nama domain kustom Regional, Anda dapat membuat API pemetaan dengan beberapa level, sepertihttps://regional.example.com/orders/v1/items/123. Anda juga dapat memetakan HTTP dan REST API tahapan ke nama domain kustom yang sama. Untuk informasi selengkapnya, lihat Memetakan API tahapan ke nama domain khusus untuk REST APIs.
