View a markdown version of this page

Tugas penyedia API dan konsumen API untuk nama domain khusus untuk API pribadi - Amazon API Gateway
Tugas penyedia APITugas konsumen API

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

Tugas penyedia API dan konsumen API untuk nama domain khusus untuk API pribadi

Saat Anda membuat nama domain kustom pribadi, Anda adalah penyedia API. Saat Anda memanggil nama domain kustom pribadi, Anda adalah konsumen API. Anda dapat menggunakan nama domain kustom pribadi dari milik Anda sendiri Akun AWS atau dari yang lain Akun AWS.

Bagian berikut menjelaskan tugas yang diperlukan oleh penyedia API dan konsumen API untuk menggunakan nama domain kustom pribadi. Jika Anda ingin memanggil nama domain khusus pribadi Anda sendiri Akun AWS, Anda adalah penyedia API dan konsumen API. Jika Anda ingin memanggil domain kustom pribadi di domain lain Akun AWS, tergantung pada hubungan kepercayaan antara penyedia API dan konsumen API di AWS Organizations, AWS RAM mungkin menyelesaikan beberapa tugas untuk Anda.

Tugas penyedia API

Penyedia API membuat API pribadi dan memetakannya ke nama domain khusus.

Penyedia API mengelola dua kebijakan sumber daya untuk melindungi nama domain kustom pribadi mereka. Kebijakan pertama adalah untuk execute-api layanan dan kontrol titik akhir VPC mana yang dapat memanggil nama domain kustom pribadi Anda. Dalam konfigurasi nama domain kustom pribadi, itu disebutpolicy.

Kebijakan kedua adalah untuk layanan Amazon API Gateway Management dan mengontrol titik akhir VPC mana yang Akun AWS dapat membentuk asosiasi akses nama domain dengan nama domain kustom pribadi Anda. Titik akhir VPC perlu membentuk asosiasi akses nama domain dengan nama domain kustom pribadi untuk memanggilnya. Dalam konfigurasi nama domain kustom pribadi, itu adalahmanagementPolicy. Anda dapat menggunakan AWS RAM atau API Gateway untuk memperbarui kebijakan ini. Jika Anda tidak berencana mengizinkan titik akhir VPC di tempat lain Akun AWS untuk memanggil nama domain kustom Anda, Anda tidak mengedit. managementPolicy

Jika Anda adalah penyedia API, Anda harus melakukan hal berikut:

  1. Buat API pribadi.

  2. Perbarui API pribadi Anda policy untuk memberikan akses titik akhir VPC Anda ke API pribadi Anda.

  3. Buat nama domain kustom pribadi.

  4. Perbarui nama domain kustom pribadi Anda policy untuk memberikan akses titik akhir VPC Anda ke nama domain kustom pribadi Anda.

  5. Buat pemetaan jalur dasar atau aturan perutean untuk mengirim lalu lintas dari API pribadi Anda ke nama domain kustom pribadi Anda. Untuk informasi selengkapnya, lihat Kirim lalu lintas ke Anda APIs melalui nama domain kustom Anda di API Gateway.

Jika Anda ingin mengizinkan konsumen API di tempat lain Akun AWS untuk mengakses nama domain kustom pribadi Anda, lakukan hal berikut:

  1. Perbarui managementPolicy nama domain kustom pribadi Anda agar pengguna API di akun lain dapat mengaitkan titik akhir VPC mereka dengan nama domain kustom pribadi Anda. Anda dapat melakukan ini menggunakan metode berikut:

    AWS RAM

    Dengan AWS RAM, jika penyedia API dan konsumen API berada di organisasi yang sama menggunakan AWS Organizations, pembagian sumber daya antara penyedia dan konsumen diterima secara otomatis. Jika tidak, Anda harus menunggu sampai konsumen API menerima pembagian sumber daya. Sebaiknya gunakan AWS RAM untuk membagikan nama domain kustom pribadi Anda.

    API Gateway

    Dengan API Gateway, hanya AWS CLI yang didukung. Anda harus memperbarui nama domain kustom pribadi Anda menggunakan operasi patch dan memberikan dokumen kebijakan Anda sendiri untukmanagementPolicy.

  2. Perbarui policy nama domain kustom pribadi Anda dan API pribadi apa pun yang dipetakan untuk memberikan akses ke titik akhir VPC konsumen API.

Untuk petunjuk tentang cara menyediakan API Anda ke yang lain Akun AWS, lihatPenyedia API: Bagikan nama domain kustom pribadi Anda menggunakan AWS RAM.

Tugas konsumen API

Konsumen API mengaitkan titik akhir VPC mereka dengan nama domain ARN untuk memanggil nama domain kustom pribadi. Konsumen API tidak perlu membuat API Gateway API.

Jika Anda adalah konsumen API, lakukan hal berikut:

  1. Buat titik akhir VPC dengan DNS pribadi diaktifkan di Amazon VPC.

  2. (Opsional - jika AWS RAM digunakan) Terima pembagian sumber daya domain kustom pribadi AWS RAM dalam waktu 12 jam setelah pembagian sumber daya. Jika Anda dan penyedia API berada di organisasi yang sama, pembagian sumber daya diterima secara otomatis.

  3. Dapatkan nama domain khusus pribadi ARN. Karena URL nama domain kustom pribadi tidak unik, Anda menggunakan nama domain kustom pribadi ARN untuk membentuk asosiasi akses nama domain antara titik akhir VPC Anda dan nama domain kustom pribadi. Anda dapat menggunakan AWS RAM untuk mengambil nama domain khusus pribadi ARN.

  4. Kaitkan domain kustom pribadi ARN dengan titik akhir VPC Anda di API Gateway. Ini menciptakan koneksi aman antara titik akhir VPC Anda dan nama domain kustom pribadi. Lalu lintas tidak meninggalkan jaringan Amazon.

  5. Tunggu penyedia API memberikan akses titik akhir VPC Anda ke nama domain kustom pribadi dan API pribadi apa pun yang dipetakan ke nama domain kustom pribadi. Jika Anda adalah penyedia API dan konsumen API, Anda memberikan akses pemanggilan titik akhir VPC Anda sendiri.

  6. Buat Zona Hosted Pribadi Route 53 dan catatan Route 53 untuk menyelesaikan nama domain kustom pribadi di Route 53.

Untuk petunjuk tentang cara menggunakan API di API lain Akun AWS, lihatKonsumen API: Mengaitkan titik akhir VPC Anda dengan nama domain kustom pribadi yang dibagikan dengan Anda.