Habilitación del almacenamiento en caché de la API para mejorar la capacidad de respuesta - Amazon API Gateway

Habilitación del almacenamiento en caché de la API para mejorar la capacidad de respuesta

Puede habilitar el almacenamiento en caché de la API en Amazon API Gateway para almacenar en caché las respuestas del punto de enlace. Con el almacenamiento en caché, puede reducir el número de llamadas realizadas al punto de enlace y mejorar también la latencia de las solicitudes a la API.

Cuando habilita el almacenamiento en caché para una etapa, API Gateway almacena en caché las respuestas del punto de enlace durante el período de tiempo de vida (TTL) especificado, en segundos. A continuación, API Gateway responde a la solicitud buscando la respuesta del punto de enlace en la caché en lugar de realizar una solicitud al punto de enlace. El valor de TTL predeterminado para el almacenamiento en caché de la API es de 300 segundos. El valor de TTL máximo es de 3600 segundos. TTL = 0 significa que el almacenamiento en caché está deshabilitado.

nota

El almacenamiento en caché es el mejor esfuerzo. Puede utilizar las métricas CacheHitCount y CacheMissCount en Amazon CloudWatch para monitorear las solicitudes que API Gateway atiende desde la caché de la API.

El tamaño máximo de una respuesta que se puede almacenar en la caché es 1048576 bytes. El cifrado de datos en la caché puede aumentar el tamaño de la respuesta cuando se almacena en la caché.

Se trata de un servicio compatible con HIPAA. Para obtener más información acerca de AWS, la ley de responsabilidad y portabilidad de seguros médicos de Estados Unidos de 1996 (HIPAA) y el uso de los servicios de AWS para procesar, almacenar y transmitir información sanitaria protegida (PHI), consulte Información general sobre la HIPAA.

importante

Al habilitar el almacenamiento en caché para una etapa, solo los métodos GET tienen el almacenamiento en caché habilitado de forma predeterminada. Esto ayuda a garantizar la seguridad y la disponibilidad de la API. Puede habilitar el almacenamiento en caché para otros métodos invalidando la configuración del método.

importante

El almacenamiento en caché se cobra por hora y no está disponible para la capa de uso gratuito de AWS.

Activar almacenamiento en caché de Amazon API Gateway

En API Gateway, puede habilitar el almacenamiento en caché para todos los métodos de una etapa especificada.

Al habilitar el almacenamiento en caché, debe elegir una capacidad de caché. En general, una capacidad mayor ofrece un mejor desempeño, pero también cuesta más.

API Gateway permite el almacenamiento en caché creando una instancia de caché dedicada. Este proceso puede tardar hasta cuatro minutos.

API Gateway cambia la capacidad de almacenamiento en caché eliminando al instancia de caché y creando una nueva con una capacidad modificada. Todos los datos almacenados en la memoria caché existente se eliminan.

nota

La capacidad de la caché afecta la CPU, la memoria y el ancho de banda de red de la instancia de caché. Como resultado, la capacidad de la caché puede afectar el rendimiento de dicha caché.

API Gateway recomienda ejecutar una prueba de carga de 10 minutos para comprobar que la capacidad de la caché sea adecuada para la carga de trabajo. Asegúrese de que durante la prueba de carga el tráfico refleje el tráfico de producción. Por ejemplo, incluya aumento gradual, tráfico constante y picos de tráfico. La prueba de carga debe incluir respuestas que se puedan entregar desde la caché, así como respuestas individuales que agreguen elementos a dicha caché. Monitoree las métricas de latencia, 4xx, 5xx, métricas de aciertos y errores de la caché durante la prueba de carga. Ajuste la capacidad de la caché según sea necesario en función de estas métricas.

En la consola de API Gateway, el almacenamiento en caché se configura en la pestaña Settings de un Stage Editor con nombre.

Para configurar el almacenamiento en caché de la API para una determinada etapa:

  1. Vaya a la consola de API Gateway.

  2. Elija la API.

  3. Elija Stages (Etapas).

  4. En la lista Stages (Etapas) de la API, elija la etapa.

  5. Elija la pestaña Settings.

  6. Elija Enable API cache (Habilitar caché de API).

  7. Espera a que se complete la creación de la caché.

nota

La creación o eliminación de una memoria caché tarda unos cuatro minutos en completarse en API Gateway. Cuando se crea una caché, el valor de Cache status (Estado de caché) cambia de CREATE_IN_PROGRESS a AVAILABLE. Cuando se completa la eliminación de la caché, el valor de Cache status (Estado de caché) cambia de DELETE_IN_PROGRESS a una cadena vacía.

Cuando se habilita el almacenamiento en caché en Cache Settings (Configuración de caché) de la etapa, solo se almacenan en caché los métodos GET. Para garantizar la seguridad y la disponibilidad de la API, le recomendamos que no cambie esta configuración. Sin embargo, puede habilitar el almacenamiento en caché para otros métodos invalidando la configuración del método.

Si desea comprobar si el almacenamiento en caché funciona según lo previsto, tiene dos opciones generales:

  • Revise las métricas de CloudWatch de CacheHitCount y CacheMissCount para la API y la etapa.

  • Inserte una marca de tiempo en la respuesta.

nota

No debe utilizar el encabezado X-Cache de la respuesta de CloudFront para determinar si la API se está sirviendo desde la instancia de caché de API Gateway.

Anular el almacenamiento en caché de nivel de etapa de API Gateway para el almacenamiento en caché de métodos

Puede anular la configuración de caché a nivel de etapa habilitando o deshabilitando el almacenamiento en caché para un método específico. Aumentando o disminuyendo su período TTL; o activando o desactivando el cifrado para las respuestas almacenadas en caché.

Si prevé que un método que almacena en caché va a recibir información confidencial en sus respuestas, en Cache Settings (Configuración de caché), elija Encrypt cache data (Cifrar datos de caché).

Para configurar los métodos individuales de almacenamiento en caché de la API para utilizar la consola:

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Vaya a la consola de API Gateway.

  3. Elija la API.

  4. Elija Stages (Etapas).

  5. En la lista Stages (Etapas) de la API, expanda la etapa y elija un método en la API.

  6. Elija Override for this method (Invalidar para este método) en Settings (Configuración).

  7. En el área Cache Settings (Configuración de caché), puede establecer o desactivar Enable Method Cache (Habilitar caché de método) o personalizar las opciones que desee. (Esta sección se muestra únicamente si está habilitado el almacenamiento en caché de nivel de etapa).

Usar parámetros de método o integración como claves de caché para indexar las respuestas almacenadas en caché

Cuando un método o una integración almacenados en caché tienen parámetros, que pueden adoptar la forma de encabezados personalizados, rutas URL o cadenas de consulta, puede utilizar algunos o todos los parámetros para crear claves de caché. API Gateway puede almacenar en memoria caché las respuestas del método, en función de los valores de los parámetros utilizados.

nota

Las claves de caché son necesarias cuando se configura el almacenamiento en caché en un recurso.

Suponga, por ejemplo, que tiene una solicitud con el siguiente formato:

GET /users?type=... HTTP/1.1 host: example.com ...

En esta solicitud, type puede tomar un valor de admin o regular. Si incluye el parámetro type como parte de la clave de caché, las respuestas de GET /users?type=admin se almacenan en caché por separado de las de GET /users?type=regular.

Cuando una solicitud de método o integración toma más de un parámetro, puede elegir algunos o todos los parámetros para crear la clave de caché. Por ejemplo, puede incluir solamente el parámetro type en la clave de caché para la siguiente solicitud, realizada en el orden indicado dentro de un período de TTL:

GET /users?type=admin&department=A HTTP/1.1 host: example.com ...

La respuesta de esta solicitud se almacena en caché y se utiliza para servir la siguiente solicitud:

GET /users?type=admin&department=B HTTP/1.1 host: example.com ...

Para incluir un parámetro de solicitud de método o integración como parte de una clave de caché en la consola de API Gateway, seleccione Caching después de agregar el parámetro.


                Incluir parámetros de método o integración como claves de caché para indexar las respuestas almacenadas en caché

Vaciar la caché de etapa de API en API Gateway

Cuando el almacenamiento en caché de la API está habilitado, puede vaciar toda la caché de etapas de API para asegurarse de que los clientes de la API obtengan las respuestas más recientes de los puntos de enlace de integración.

Para vaciar la caché de etapas de la API, puede elegir el botón Flush entire cache (vaciar caché completa) en la sección Cache Settings (Ajustes de caché) de la pestaña Settings (Configuración) en el editor de etapas de la consola de API Gateway. La operación de vaciado de memoria caché tarda unos minutos, tras la cual el estado es AVAILABLE inmediatamente después del vaciado.

nota

Después de que la caché se vacía, las respuestas se atienden desde el punto de enlace de integración hasta que se vuelva a crear la caché. Durante este período, el número de solicitudes enviadas al punto de enlace de integración puede aumentar. Esto podría aumentar temporalmente la latencia total de la API.

Invalidar una entrada de caché de API Gateway

Un cliente de la API puede invalidar una entrada de caché existente y volver a cargarla desde el punto de enlace de integración para las distintas solicitudes. El cliente debe enviar una solicitud que contenga el encabezado Cache-Control: max-age=0. El cliente recibe la respuesta directamente del punto de enlace de integración en lugar de la caché, siempre que el cliente esté autorizado para ello. Esto sustituye la entrada de caché existente por la nueva respuesta, que se obtiene del punto de enlace de integración.

Para conceder permiso a un cliente, asocie una política con el siguiente formato a una función de ejecución de IAM del usuario.

nota

No se admite la invalidación de la memoria caché entre cuentas.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "execute-api:InvalidateCache" ], "Resource": [ "arn:aws:execute-api:region:account-id:api-id/stage-name/GET/resource-path-specifier" ] } ] }

Esta política permite al servicio de ejecución de API Gateway invalidar la caché para las solicitudes en el recurso o recursos especificados. Para especificar un grupo de recursos de destino, utilice el carácter comodín (*) para account-id, api-id y otras entradas en el valor de ARN de Resource. Para obtener más información sobre cómo establecer permisos para el servicio de ejecución de API Gateway, consulte Control del acceso a una API con permisos de IAM.

Si no impone una política InvalidateCache (o selecciona la casilla de verificación Require authorization (Solicitar autorización)), cualquier cliente puede invalidar la caché de la API. Si la mayoría o todos los clientes invalidan la caché de la API, esto podría aumentar considerablemente la latencia de la API.

Cuando la política está implantada, se habilita el almacenamiento en caché y se requiere autorización. Puede controlar cómo se gestionan las solicitudes no autorizadas eligiendo una opción de Handle unauthorized requests (Manejar solicitudes no autorizadas) en la consola de API Gateway.


                Configurar la invalidación de caché

Las tres opciones producen los siguientes comportamientos:

  • Fail the request with 403 status code (Error de la solicitud con el código de estado 403): devuelve una respuesta 403 Unauthorized.

    Para establecer esta opción mediante la API, use FAIL_WITH_403.

  • Ignore cache control header; Add a warning in response header (Omitir encabezado de control de caché; agregar una advertencia en el encabezado de respuesta): procesa la solicitud y agrega un encabezado de advertencia en la respuesta.

    Para establecer esta opción mediante la API, use SUCCEED_WITH_RESPONSE_HEADER.

  • Ignore cache control header (Omitir encabezado de control de caché): procesa la solicitud y no agrega un encabezado de advertencia en la respuesta.

    Para establecer esta opción mediante la API, use SUCCEED_WITHOUT_RESPONSE_HEADER.