Mengambil konfigurasi dengan langsung memanggil API - AWS AppConfig

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

Mengambil konfigurasi dengan langsung memanggil API

Aplikasi Anda mengambil data konfigurasi dengan terlebih dahulu membuat sesi konfigurasi menggunakan operasi StartConfigurationSession API. Klien sesi Anda kemudian membuat panggilan berkala ke GetLatestKonfigurasi untuk memeriksa dan mengambil data terbaru yang tersedia.

Saat meneleponStartConfigurationSession, kode Anda mengirimkan informasi berikut:

  • Pengidentifikasi (ID atau nama) AWS AppConfig aplikasi, lingkungan, dan profil konfigurasi yang dilacak sesi.

  • (Opsional) Jumlah minimum waktu klien sesi harus menunggu di antara panggilan keGetLatestConfiguration.

Sebagai tanggapan, AWS AppConfig berikan InitialConfigurationToken untuk diberikan kepada klien sesi dan digunakan saat pertama kali memanggil GetLatestConfiguration sesi itu.

penting

Token ini hanya boleh digunakan sekali dalam panggilan pertama AndaGetLatestConfiguration. Anda harus menggunakan token baru di GetLatestConfiguration response (NextPollConfigurationToken) di setiap panggilan berikutnyaGetLatestConfiguration. Untuk mendukung kasus penggunaan polling yang panjang, token berlaku hingga 24 jam. Jika GetLatestConfiguration panggilan menggunakan token kedaluwarsa, sistem akan kembaliBadRequestException.

Saat meneleponGetLatestConfiguration, kode klien Anda mengirimkan ConfigurationToken nilai terbaru yang dimilikinya dan diterima sebagai tanggapan:

  • NextPollConfigurationToken: ConfigurationToken nilai yang akan digunakan pada panggilan berikutnya keGetLatestConfiguration.

  • NextPollIntervalInSeconds: durasi yang harus ditunggu klien sebelum melakukan panggilan berikutnyaGetLatestConfiguration.

  • Konfigurasi: data terbaru yang ditujukan untuk sesi tersebut. Ini mungkin kosong jika klien sudah memiliki versi konfigurasi terbaru.

penting

Perhatikan informasi penting berikut.

  • StartConfigurationSession API hanya boleh dipanggil sekali per aplikasi, lingkungan, profil konfigurasi, dan klien untuk membuat sesi dengan layanan. Ini biasanya dilakukan dalam startup aplikasi Anda atau segera sebelum pengambilan konfigurasi pertama.

  • Jika konfigurasi Anda digunakan menggunakan aKmsKeyIdentifier, permintaan Anda untuk menerima konfigurasi harus menyertakan izin untuk memanggilkms:Decrypt. Untuk informasi selengkapnya, lihat Mendekripsi di Referensi AWS Key Management Service API.

  • Operasi API yang sebelumnya digunakan untuk mengambil data konfigurasiGetConfiguration, tidak digunakan lagi. Operasi GetConfiguration API tidak mendukung konfigurasi terenkripsi.

Mengambil contoh konfigurasi

AWS CLI Contoh berikut menunjukkan cara mengambil data konfigurasi dengan menggunakan operasi AWS AppConfig Data StartConfigurationSession dan GetLatestConfiguration API. Perintah pertama memulai sesi konfigurasi. Panggilan ini mencakup ID (atau nama) AWS AppConfig aplikasi, lingkungan, dan profil konfigurasi. API mengembalikan yang InitialConfigurationToken digunakan untuk mengambil data konfigurasi Anda.

aws appconfigdata start-configuration-session \ --application-identifier application_name_or_ID \ --environment-identifier environment_name_or_ID \ --configuration-profile-identifier configuration_profile_name_or_ID

Sistem merespons dengan informasi dalam format berikut.

{ "InitialConfigurationToken": initial configuration token }

Setelah memulai sesi, gunakan InitialConfigurationToken untuk memanggil GetLatestKonfigurasi untuk mengambil data konfigurasi Anda. Data konfigurasi disimpan ke mydata.json file.

aws appconfigdata get-latest-configuration \ --configuration-token initial configuration token mydata.json

Panggilan pertama untuk GetLatestConfiguration menggunakan yang ConfigurationToken diperoleh dariStartConfigurationSession. Informasi berikut dikembalikan.

{ "NextPollConfigurationToken" : next configuration token, "ContentType" : content type of configuration, "NextPollIntervalInSeconds" : 60 }

Panggilan selanjutnya GetLatestConfiguration harus diberikan NextPollConfigurationToken dari respons sebelumnya.

aws appconfigdata get-latest-configuration \ --configuration-token next configuration token mydata.json
penting

Perhatikan detail penting berikut tentang operasi GetLatestConfiguration API:

  • GetLatestConfigurationResponsnya mencakup Configuration bagian yang menunjukkan data konfigurasi. ConfigurationBagian ini hanya muncul jika sistem menemukan data konfigurasi baru atau yang diperbarui. Jika sistem tidak menemukan data konfigurasi baru atau yang diperbarui, maka Configuration datanya kosong.

  • Anda menerima yang baru ConfigurationToken dalam setiap tanggapan dariGetLatestConfiguration.

  • Sebaiknya atur frekuensi polling panggilan GetLatestConfiguration API Anda berdasarkan anggaran, frekuensi penerapan konfigurasi yang diharapkan, dan jumlah target untuk konfigurasi.