Mengubah jenis titik akhir API publik atau pribadi di API Gateway

Mengubah tipe titik akhir API mengharuskan Anda memperbarui konfigurasi API. Anda dapat mengubah jenis API yang ada menggunakan konsol API Gateway, the AWS CLI, atau AWS SDK untuk API Gateway. Jenis titik akhir tidak dapat diubah lagi hingga perubahan saat ini selesai, tetapi API Anda akan tersedia.

Perubahan tipe endpoint berikut didukung:

• Dari yang dioptimalkan tepi ke Regional atau pribadi

• Dari Regional hingga yang dioptimalkan tepi atau pribadi

• Dari pribadi ke Regional

Anda tidak dapat mengubah API pribadi menjadi API yang dioptimalkan tepi.

Jika Anda mengubah API publik dari yang dioptimalkan tepi ke Regional atau sebaliknya, perhatikan bahwa API yang dioptimalkan tepi mungkin memiliki perilaku yang berbeda dari API Regional. Misalnya, API yang dioptimalkan tepi menghapus header. Content-MD5 Nilai hash MD5 apa pun yang diteruskan ke backend dapat dinyatakan dalam parameter string permintaan atau properti tubuh. Namun, API Regional meneruskan header ini, meskipun mungkin memetakan ulang nama header ke beberapa nama lain. Memahami perbedaan membantu Anda memutuskan cara memperbarui API yang dioptimalkan tepi ke API Regional atau dari API Regional ke API yang dioptimalkan tepi.

Menggunakan konsol API Gateway untuk mengubah jenis titik akhir API

Untuk mengubah jenis titik akhir API API Anda, lakukan salah satu set langkah berikut:

Untuk mengonversi titik akhir publik dari Regional atau yang dioptimalkan tepi dan sebaliknya

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

2. Pilih REST API.

3. Pilih setelan API.

4. Di bagian detail API, pilih Edit.

5. Untuk jenis endpoint API, pilih Edge-optimized atau Regional.

6. Pilih Simpan perubahan.

7. Menerapkan ulang API Anda sehingga perubahan akan berlaku.

Untuk mengonversi titik akhir pribadi ke titik akhir Regional

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

2. Pilih REST API.

3. Edit kebijakan sumber daya untuk API Anda untuk menghapus penyebutan VPC atau titik akhir VPC sehingga panggilan API dari luar VPC Anda maupun di dalam VPC Anda akan berhasil.

4. Pilih setelan API.

5. Di bagian detail API, pilih Edit.

6. Untuk jenis titik akhir API, pilih Regional.

7. Pilih Simpan perubahan.

8. Hapus kebijakan sumber daya dari API Anda.

9. Menerapkan ulang API Anda sehingga perubahan akan berlaku.

Untuk mengonversi titik akhir Regional menjadi titik akhir pribadi

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

2. Pilih REST API.

3. Buat kebijakan sumber daya yang memberikan akses ke titik akhir VPC atau VPC Anda. Untuk informasi selengkapnya, lihat Langkah 3: Siapkan kebijakan sumber daya untuk pribadi API.

4. Pilih setelan API.

5. Di bagian detail API, pilih Edit.

6. Untuk jenis endpoint API, pilih Private.

7. (Opsional) Untuk ID titik akhir VPC, pilih ID titik akhir VPC yang ingin Anda kaitkan dengan API pribadi Anda.

8. Pilih Simpan perubahan.

9. Menerapkan ulang API Anda sehingga perubahan akan berlaku.

Gunakan AWS CLI untuk mengubah tipe titik akhir API

Untuk menggunakan AWS CLI untuk memperbarui API yang dioptimalkan tepi yang ID API-nya{api-id}, panggil update-rest-apisebagai berikut:

aws apigateway update-rest-api \
    --rest-api-id {api-id} \
    --patch-operations op=replace,path=/endpointConfiguration/types/EDGE,value=REGIONAL

Respons yang berhasil memiliki kode status 200 OK dan muatan yang mirip dengan yang berikut ini:

{
    
    "createdDate": "2017-10-16T04:09:31Z",
    "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints",
    "endpointConfiguration": {
        "types": "REGIONAL"
    },
    "id": "0gsnjtjck8",
    "name": "PetStore imported as edge-optimized"
}

Sebaliknya, perbarui API regional ke API yang dioptimalkan tepi sebagai berikut:

aws apigateway update-rest-api \
    --rest-api-id {api-id} \
    --patch-operations op=replace,path=/endpointConfiguration/types/REGIONAL,value=EDGE

Karena put-rest-apiuntuk memperbarui definisi API, itu tidak berlaku untuk memperbarui jenis titik akhir API.