Recuperación de configuraciones mediante una llamada directa a las API - AWS AppConfig

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Recuperación de configuraciones mediante una llamada directa a las API

La aplicación recupera los datos de configuración estableciendo primero una sesión de configuración mediante la operación de la API de StartConfigurationsesión. A continuación, el cliente de la sesión realiza llamadas periódicas a GetLatestConfiguration para comprobar y recuperar los últimos datos disponibles.

Al llamar a StartConfigurationSession, el código envía la siguiente información:

  • Identificadores (ID o nombre) de una AWS AppConfig aplicación, un entorno y un perfil de configuración que la sesión rastrea.

  • (Opcional) Tiempo mínimo que el cliente de la sesión debe esperar entre llamadas a GetLatestConfiguration.

Como respuesta, AWS AppConfig proporciona un valor InitialConfigurationToken que se proporciona al cliente de la sesión y se utiliza la primera vez que llama a GetLatestConfiguration esa sesión.

importante

Este token solo debe usarse una vez en la primera llamada a GetLatestConfiguration. Debe usar el nuevo token en la respuesta de GetLatestConfiguration (NextPollConfigurationToken) en cada llamada posterior a GetLatestConfiguration. Para admitir los casos de uso de sondeos prolongados, los tokens son válidos durante un máximo de 24 horas. Si en una llamada a GetLatestConfiguration se utiliza un token caducado, el sistema devuelve BadRequestException.

Al llamar a GetLatestConfiguration, su código de cliente envía el valor más reciente de ConfigurationToken del que dispone y recibe como respuesta:

  • NextPollConfigurationToken: el valor de ConfigurationToken que se utilizará en la siguiente llamada a GetLatestConfiguration.

  • NextPollIntervalInSeconds: Tiempo que el cliente debe esperar antes de realizar su próxima llamada a GetLatestConfiguration.

  • Configuración: los datos más recientes destinados a la sesión. Puede estar vacía si el cliente ya tiene la versión más reciente de la configuración.

importante

Tenga en cuenta la siguiente información importante.

  • Solo se debe llamar a la API de StartConfigurationsesión una vez por aplicación, entorno, perfil de configuración y cliente para establecer una sesión con el servicio. Por lo general, se hace al iniciar la aplicación o inmediatamente antes de recuperar una configuración por primera vez.

  • Si la configuración se implementa mediante un KmsKeyIdentifier, la solicitud para recibir la configuración debe incluir el permiso para llamar a kms:Decrypt. Para obtener más información, consulte Descifrar en la Guía de referencia de la API de AWS Key Management Service .

  • La operación de API que se utilizaba anteriormente para recuperar los datos de configuración, GetConfiguration, ha quedado obsoleta. La operación de API GetConfiguration no admite configuraciones cifradas.

Recuperación de un ejemplo de configuración

El siguiente AWS CLI ejemplo muestra cómo recuperar los datos de configuración mediante las operaciones de AWS AppConfig datos StartConfigurationSession y GetLatestConfiguration API. El primer comando inicia una sesión de configuración. Esta llamada incluye los ID (o nombres) de la AWS AppConfig aplicación, el entorno y el perfil de configuración. La API devuelve un InitialConfigurationToken que se utiliza para recuperar los datos de configuración.

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

El sistema devuelve información similar al siguiente formato.

{ "InitialConfigurationToken": initial configuration token }

Tras iniciar una sesión, utilice InitialConfigurationToken para llamar a GetLatestConfiguration y obtener los datos de configuración. Los datos de configuración se guardan en el archivo mydata.json.

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

La primera llamada a GetLatestConfiguration utiliza el ConfigurationToken obtenido de StartConfigurationSession. Se devuelve la siguiente información.

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

Las llamadas posteriores a GetLatestConfiguration deben proporcionar el NextPollConfigurationToken de la respuesta anterior.

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

Tenga en cuenta los siguientes detalles importantes acerca de la operación de API GetLatestConfiguration:

  • La respuesta de GetLatestConfiguration incluye una sección Configuration que muestra los datos de configuración. La sección Configuration solo aparece si el sistema encuentra datos de configuración nuevos o actualizados. Si el sistema no encuentra datos de configuración nuevos o actualizados, los datos de Configuration están vacíos.

  • Recibirá un nuevo ConfigurationToken en cada respuesta de GetLatestConfiguration.

  • Recomendamos ajustar la frecuencia de sondeo de las llamadas a la API GetLatestConfiguration en función del presupuesto, la frecuencia esperada de las implementaciones de configuración y el número de destinos para una configuración.