Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Mengatur API kunci menggunakan API Gateway REST API
Untuk mengatur API kunci, lakukan hal berikut:
Konfigurasikan API metode untuk memerlukan API kunci.
Membuat atau mengimpor API kunci untuk API di wilayah.
Sebelum menyiapkan API kunci, Anda harus membuat API dan menerapkannya ke panggung. Setelah Anda membuat nilai API kunci, itu tidak dapat diubah.
Untuk REST API panggilan untuk membuat dan menyebarkanAPI, lihat restapi:create
dan deployment:create
, masing-masing.
catatan
Untuk praktik terbaik untuk dipertimbangkan, lihatPraktik terbaik untuk API kunci dan paket penggunaan.
Memerlukan API kunci pada metode
Untuk meminta API kunci pada metode, lakukan salah satu hal berikut:
-
Panggilan
method:put
untuk membuat metode. SetelapiKeyRequired
ketrue
dalam payload permintaan. -
Panggilan
method:update
untuk mengaturapiKeyRequired
ketrue
.
Buat atau impor API kunci
Untuk membuat atau mengimpor API kunci, lakukan salah satu hal berikut:
-
Panggil
apikey:create
untuk membuat API kunci. -
Panggilan
apikey:import
untuk mengimpor API kunci dari file. Untuk format file, lihatAPIFormat file API kunci gateway.
Anda tidak dapat mengubah nilai API kunci baru. Untuk mempelajari cara mengonfigurasi paket penggunaan, lihatMembuat, mengonfigurasi, dan menguji paket penggunaan menggunakan API Gateway CLI dan REST API.