Siapkan panggung untuk REST API in API Gateway - APIGerbang Amazon
Buat panggung baruPerbarui pengaturan panggungGanti pengaturan tingkat panggung

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

Siapkan panggung untuk REST API in API Gateway

Tahap adalah referensi bernama untuk penyebaran, yang merupakan snapshot dari. API Anda menggunakan Stage untuk mengelola dan mengoptimalkan penerapan tertentu. Misalnya, Anda dapat mengonfigurasi pengaturan tahap untuk mengaktifkan caching, menyesuaikan pembatasan permintaan, mengonfigurasi logging, menentukan variabel tahap, atau melampirkan rilis kenari untuk pengujian. Bagian berikut menunjukkan cara membuat dan mengkonfigurasi panggung Anda.

Buat panggung baru

Setelah penerapan awal, Anda dapat menambahkan lebih banyak tahapan dan mengaitkannya dengan penerapan yang ada. Anda dapat menggunakan konsol API Gateway untuk membuat tahap baru, atau Anda dapat memilih tahap yang ada saat menerapkan. API Secara umum, Anda dapat menambahkan tahap baru ke API penerapan sebelum menerapkan ulang. API Untuk membuat tahap baru menggunakan konsol API Gateway, ikuti langkah-langkah berikut:

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

  2. Pilih RESTAPI.

  3. Di panel navigasi utama, pilih Tahapan di bawah. API

  4. Dari panel navigasi Tahapan, pilih Buat tahap.

  5. Untuk nama Panggung, masukkan nama, misalnya,prod.

    catatan

    Nama panggung hanya dapat berisi karakter alfanumerik, tanda hubung, dan garis bawah. Panjang maksimum adalah 128 karakter.

  6. (Opsional). Untuk Deskripsi, masukkan deskripsi panggung.

  7. Untuk Deployment, pilih tanggal dan waktu API penyebaran yang ada yang ingin Anda kaitkan dengan tahap ini.

  8. Di bawah Pengaturan tambahan, Anda dapat menentukan pengaturan tambahan untuk panggung Anda.

  9. Pilih Buat panggung.

Ubah pengaturan panggung

Setelah penerapan yang berhasilAPI, panggung diisi dengan pengaturan default. Anda dapat menggunakan konsol atau API Gateway REST API untuk mengubah pengaturan panggung, termasuk API caching dan logging. Langkah-langkah berikut menunjukkan cara melakukannya menggunakan editor Stage dari konsol API Gateway.

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

  2. Pilih RESTAPI.

  3. Di panel navigasi utama, pilih Tahapan di bawah. API

  4. Di panel Tahapan, pilih nama panggung.

  5. Di bagian Detail tahap, pilih Edit.

  6. (Opsional) Untuk deskripsi Tahap, edit deskripsi.

  7. Untuk pengaturan tambahan, Anda mengubah pengaturan berikut:

    Pengaturan cache

    Untuk mengaktifkan API caching untuk panggung, aktifkan APIcache Provision. Kemudian konfigurasikan caching tingkat metode Default, Kapasitas cache, Enkripsi data cache, Cache time-to-live (TTL), serta persyaratan apa pun untuk pembatalan cache per kunci.

    Caching tidak aktif sampai Anda mengaktifkan caching tingkat metode default atau mengaktifkan cache tingkat metode untuk metode tertentu.

    Untuk informasi selengkapnya tentang pengaturan cache, lihatPengaturan cache untuk REST APIs di API Gateway.

    catatan

    Jika Anda mengaktifkan API caching untuk suatu API tahap, AWS akun Anda mungkin dikenakan biaya untuk API caching. Caching tidak memenuhi syarat untuk Tingkat AWS Gratis.

    Pengaturan pelambatan

    Untuk menetapkan target pelambatan tingkat tahap untuk semua metode yang terkait dengan iniAPI, aktifkan Throttling.

    Untuk Rate, masukkan target rate. Ini adalah tarif, dalam permintaan per detik, token ditambahkan ke ember token. Tingkat tingkat tahap tidak boleh lebih dari tingkat tingkat akun seperti yang ditentukan dalam. APIKuota gateway untuk mengonfigurasi dan menjalankan REST API

    Untuk Burst, masukkan target burst rate. Tingkat ledakan, adalah kapasitas ember token. Ini memungkinkan lebih banyak permintaan melalui untuk jangka waktu tertentu daripada tingkat target. Tingkat ledakan tingkat tahap ini tidak boleh lebih dari tingkat burst rate akun seperti yang ditentukan dalam. APIKuota gateway untuk mengonfigurasi dan menjalankan REST API

    catatan

    Tarif pelambatan bukanlah batas yang sulit, dan diterapkan atas dasar upaya terbaik. Dalam beberapa kasus, klien dapat melebihi target yang Anda tetapkan. Jangan mengandalkan pembatasan untuk mengontrol biaya atau memblokir akses ke file. API Pertimbangkan AWS Budgetsuntuk menggunakan untuk memantau biaya dan AWS WAFmengelola API permintaan.

    Pengaturan firewall dan sertifikat

    Untuk mengaitkan AWS WAF web ACL dengan panggung, pilih web ACL dari daftar ACL dropdown Web. Jika diinginkan, pilih Blokir API Permintaan jika Web ACL tidak dapat dievaluasi (Gagal- Tutup).

    Untuk memilih sertifikat klien untuk tahap Anda, pilih sertifikat dari menu tarik-turun sertifikat Klien.

  8. Pilih Lanjutkan.

  9. Tinjau perubahan Anda dan pilih Simpan perubahan.

  10. Untuk mengaktifkan CloudWatch Log Amazon untuk semua metode yang terkait dengan tahap API Gateway iniAPI, di bagian Log dan penelusuran, pilih Edit.

    catatan

    Untuk mengaktifkan CloudWatch Log, Anda juga harus menentukan ARN IAM peran yang memungkinkan API Gateway untuk menulis informasi ke CloudWatch Log atas nama pengguna Anda. Untuk melakukannya, pilih Pengaturan dari panel navigasi APIsutama. Kemudian, untuk peran CloudWatch log, masukkan IAM peran. ARN

    Untuk skenario aplikasi umum, IAM peran dapat melampirkan kebijakan terkelolaAmazonAPIGatewayPushToCloudWatchLogs, yang berisi pernyataan kebijakan akses berikut:

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:DescribeLogGroups",
                "logs:DescribeLogStreams",
                "logs:PutLogEvents",
                "logs:GetLogEvents",
                "logs:FilterLogEvents"
            ],
            "Resource": "*"
        }
    ]
}

    IAMPeran tersebut juga harus berisi pernyataan hubungan kepercayaan berikut:

    {
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "Service": "apigateway.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

    Untuk informasi selengkapnya CloudWatch, lihat Panduan CloudWatch Pengguna Amazon.

  11. Pilih level logging dari menu dropdown CloudWatch Log. Level logging adalah sebagai berikut:

    • Mati - Logging tidak diaktifkan untuk tahap ini.

    • Hanya kesalahan - Logging diaktifkan hanya untuk kesalahan.

    • Kesalahan dan info log - Logging diaktifkan untuk semua acara.

  12. Pilih Penelusuran data agar API Gateway melaporkan ke CloudWatch pencatatan jejak data untuk tahap Anda. Ini dapat berguna untuk memecahkan masalahAPIs, tetapi dapat mengakibatkan pencatatan data sensitif.

    catatan

    Kami menyarankan Anda untuk tidak menggunakan penelusuran data untuk produksiAPIs.

  13. Pilih Metrik terperinci agar API Gateway melaporkan API metrikAPI calls,,, Latency Integration latency400 errors, dan. CloudWatch 500 errors Untuk informasi selengkapnya CloudWatch, lihat Pemantauan dasar dan pemantauan terperinci di Panduan CloudWatch Pengguna Amazon.

    penting

    Akun Anda dikenakan biaya untuk mengakses metrik tingkat metode, tetapi bukan CloudWatch metrik API -level atau level tahap.

  14. Untuk mengaktifkan pencatatan akses ke tujuan, aktifkan Pencatatan akses khusus.

  15. Untuk tujuan log Access ARN, masukkan grup log atau aliran Firehose. ARN

    ARNFormat untuk Firehose adalah. arn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name} Nama aliran Firehose Anda harus. amazon-apigateway-{your-stream-name}

  16. Dalam format Log, masukkan format log. Untuk mempelajari lebih lanjut tentang contoh format log, lihatCloudWatch format log untuk API Gateway.

  17. Untuk mengaktifkan AWS X-Raypenelusuran untuk API panggung, pilih penelusuran X-Ray. Untuk informasi selengkapnya, lihat Lacak permintaan pengguna ke REST API menggunakan X-Ray di API Gateway.

  18. Pilih Simpan perubahan. Menerapkan ulang pengaturan Anda API untuk menerapkan pengaturan baru.

Ganti pengaturan tingkat panggung

Setelah Anda menyesuaikan pengaturan tingkat tahap, Anda dapat menggantinya untuk setiap metode. API Beberapa opsi ini dapat mengakibatkan biaya tambahan untuk Anda Akun AWS.

  1. Untuk mengonfigurasi penggantian metode, perluas tahap di bawah panel navigasi sekunder, lalu pilih metode.

    Perluas panggung di bawah panel navigasi sekunder, dan pilih metode.

  2. Untuk penggantian Metode, pilih Edit.

  3. Untuk mengaktifkan CloudWatch pengaturan tingkat metode, untuk CloudWatch Log, pilih level logging.

  4. Untuk mengaktifkan pencatatan jejak data untuk metode Anda, pilih Penelusuran data.

    catatan

    Kami menyarankan Anda untuk tidak menggunakan penelusuran data untuk produksiAPIs.

  5. Untuk mengaktifkan metrik detail tingkat metode, pilih Metrik terperinci. Akun Anda dikenakan biaya untuk mengakses metrik tingkat metode, tetapi bukan CloudWatch metrik API -level atau level tahap.

  6. Untuk mengaktifkan pelambatan tingkat metode, pilih Throttling. Masukkan opsi tingkat metode yang sesuai. Untuk mempelajari selengkapnya tentang throttling, lihat. Throttle request ke REST API Anda untuk throughput yang lebih baik di API Gateway

  7. Untuk mengkonfigurasi cache tingkat metode, pilih Aktifkan cache metode. Jika Anda mengubah pengaturan caching tingkat metode default di detail Tahap, itu tidak memengaruhi pengaturan ini.

  8. Pilih Simpan.