Almacenamiento en caché de respuestas para mejorar el rendimiento

Para activar y configurar el almacenamiento en caché de respuesta para un gateway de API mediante la consola:

1. Cree o actualice un gateway de API mediante la consola.

   Para obtener más información, consulte Creación de un gateway de API y Actualización de un gateway de API.

2. En la sección Opciones avanzadas del cuadro de diálogo Crear gateway, seleccione el botón Activar junto a Almacenamiento en caché de respuesta y:

   1. Especifique las opciones de Cache Server, de la siguiente manera:
      • Host: nombre de host del servidor de caché. Por ejemplo, "cache.example.com".
      • Número de Puerto: Número de puerto del servidor de caché. Por ejemplo, 6379.
   2. Especifique las opciones de Credenciales del Servidor de Caché de la siguiente forma:
      • Almacén: nombre del almacén en el servicio Vault que contiene las credenciales para conectarse al servidor de caché.
      • Secreto de almacén: nombre del secreto en el almacén especificado que contiene las credenciales para conectarse al servidor de caché.
      • Número de versión del secreto de almacén: versión del secreto que se va a utilizar.
   3. Especifique las opciones de Conexión de Servidor de Caché de la siguiente forma:
      • Usar SSL/TLS en solicitudes: indica si el servidor de caché está activado para TLS y, por lo tanto, si se debe configurar una conexión segura entre el gateway de API y el servidor de caché mediante TLS (anteriormente SSL).
      • Verificar certificado SSL/TLS: indica si el gateway de API verifica el certificado TLS (anteriormente SSL) del servidor de caché. Tenga en cuenta que solo se verifican actualmente los certificados firmados por autoridades de certificación públicas.
      • Timeout de Conexión: Tiempo de espera antes de abandonar un intento de conexión al servidor de caché, en milisegundos. Si el gateway de API no se puede conectar al servidor de caché en este momento, el gateway de API no recupera datos almacenados previamente en caché del servidor de caché y no escribe nuevos datos en el servidor de caché para una posible reutilización futura.
      • Timeout de Lectura: Tiempo de espera antes de abandonar un intento de lectura de datos del servidor de caché, en milisegundos. Si el gateway de API no puede recuperar datos del servidor de caché en este momento, el gateway de API envía una solicitud al servicio de backend en su lugar.
      • Timeout de Envío: Tiempo de espera antes de abandonar un intento de escritura de datos en el servidor de caché, en milisegundos. Si el gateway de API no puede enviar datos al servidor de caché en este momento, no se almacena en caché una respuesta para una posible reutilización futura.
3. Seleccione Crear o Guardar cambios para crear o actualizar el gateway de API.

Para activar y configurar el almacenamiento en caché de respuesta para un gateway de API mediante la CLI y un archivo JSON:

1. Con su editor de JSON preferido, cree un archivo de configuración de caché con el formato:

   {
     "type" : "EXTERNAL_RESP_CACHE",
     "servers" : [
       {
         "host" : "<cache-server-hostname>",
         "port" : <port-number>
       }
     ],
     "authenticationSecretId" : "<secret-ocid>",
     "authenticationSecretVersionNumber" : <secret-version-number>,
     "isSSLEnabled" : <true|false>,
     "isSSLVerifyDisabled" : <true|false>,
     "connectTimeoutInMs" : <milliseconds>,
     "readTimeoutInMs" : <milliseconds>,
     "readTimeoutInMs" : <milliseconds>
   }

   donde:

   • "type" : "EXTERNAL_RESP_CACHE" indica que se debe activar el almacenamiento en caché de respuesta. Si no se define, el valor por defecto es "type" : "NONE", lo que indica que el almacenamiento en caché de respuesta está desactivado.
   • "host" : "<cache-server-hostname>" es el nombre de host del servidor de caché. Por ejemplo, "host" : "cache.example.com".
   • "port" : <port-number> es el número de puerto del servidor de caché. Por ejemplo, "port" : 6379.
   • "authenticationSecretId" : "<secret-ocid>" es el OCID del secreto definido en un almacén del servicio Vault que contiene las credenciales para conectarse al servidor de caché. Por ejemplo, "authenticationSecretId" : "ocid.oc1.sms.secret.aaaaaa______gbdn"
   • "authenticationSecretVersionNumber" : <secret-version-number> es la versión del secreto que se va a utilizar. Por ejemplo, "authenticationSecretVersionNumber" : 1
   • "isSSLEnabled" : <true|false> indica si el servidor de caché está activado para TLS y, por lo tanto, si se debe configurar una conexión segura entre el gateway de API y el servidor de caché a través de TLS (anteriormente SSL). Si no se define, el valor por defecto es false
   • "isSSLVerifyDisabled" : <true|false> indica si el gateway de API verifica el certificado TLS (anteriormente SSL) del servidor de caché. Tenga en cuenta que solo se verifican actualmente los certificados firmados por las autoridades de certificación públicas. Si no se define, el valor por defecto es false
   • "connectTimeoutInMs" : <milliseconds> indica cuánto tiempo se debe esperar antes de abandonar un intento de conexión al servidor de caché, en milisegundos. Si el gateway de API no se puede conectar al servidor de caché en este momento, el gateway de API no recupera los datos almacenados en caché anteriormente del servidor de caché y no escribe nuevos datos en el servidor de caché para su posible reutilización futura. Si no se define, el valor por defecto es 1000. Por ejemplo, "connectTimeoutInMs" : 1500
   • "readTimeoutInMs" : <milliseconds> indica cuánto tiempo se debe esperar antes de abandonar un intento de lectura de datos del servidor de caché, en milisegundos. Si el gateway de API no puede recuperar datos del servidor de caché en este momento, el gateway de API envía una solicitud al servicio de backend en su lugar. Si no se define, el valor por defecto es 1000. Por ejemplo, "readTimeoutInMs" : 250
   • "sendTimeoutInMs" : <milliseconds> indica cuánto tiempo se debe esperar antes de abandonar un intento de escritura de datos en el servidor de caché, en milisegundos. Si el gateway de API no puede enviar datos al servidor de caché en este momento, las respuestas no se almacenan en caché para su posible reutilización futura. Si no se define, el valor por defecto es 1000. Por ejemplo, "sendTimeoutInMs" : 1250

   Por ejemplo:

   {
     "type" : "EXTERNAL_RESP_CACHE",
     "servers" : [
       {
         "host" : "cache.example.com",
         "port" : 6379
       }
     ],
     "authenticationSecretId" : "ocid.oc1.sms.secret.aaaaaa______gbdn",
     "authenticationSecretVersionNumber" : 1,
     "isSSLEnabled" : true,
     "isSSLVerifyDisabled" : false,
     "connectTimeoutInMs" : 1000,
     "readTimeoutInMs" : 250,
     "sendTimeoutInMs" : 1000
   }

2. Guarde el archivo de configuración de caché con el nombre que desee. Por ejemplo, resp-cache-config.json
3. Utilice el archivo de configuración de caché al crear o actualizar un gateway de API mediante la CLI:
   • Para crear un nuevo gateway de API con el almacenamiento en caché de respuesta activado, siga las instrucciones de la CLI en Creación de un gateway de API y defina el parámetro --response-cache-details en el nombre y la ubicación del archivo de configuración de caché. Por ejemplo:

     oci api-gateway gateway create --display-name "Hello World Gateway" --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --endpoint-type "PRIVATE" --subnet-id ocid1.subnet.oc1.iad.aaaaaaaaz______rca --response-cache-details file:///etc/caches/resp-cache-config.json

   • Para actualizar un gateway de API existente para activar el almacenamiento en caché de respuesta o cambiar los valores de almacenamiento en caché de respuesta, siga las instrucciones de la CLI en Actualización de un gateway de API y defina el parámetro --response-cache-details en el nombre y la ubicación del archivo de configuración de caché. Por ejemplo:

     oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --response-cache-details file:///etc/caches/resp-cache-config.json

Para agregar políticas de solicitud y políticas de respuesta de almacenamiento en caché de respuesta a una especificación de despliegue de API mediante la consola:

1. Cree o actualice un despliegue de API con la consola, seleccione la opción Desde cero e introduzca los detalles en la página Información básica.

   Para obtener más información, consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API y Actualización de un gateway de API.

2. Seleccione Siguiente para introducir detalles de rutas individuales en el despliegue de API en la página Rutas y seleccione Almacenamiento en Caché de Respuesta.

3. Seleccione la opción Almacenamiento en Caché para esta Ruta y especifique las opciones de almacenamiento en caché de respuesta que se aplican a esta ruta concreta:
   • TTL (tiempo de actividad) para respuestas en caché en segundos: tiempo durante el que los datos en caché están disponibles en el servidor de caché para esta ruta concreta.
   • Altas de Clave de Caché: una o más variables de contexto que agregar a la clave de caché por defecto para asociar más estrechamente una respuesta almacenada en caché a una solicitud concreta. Por ejemplo, request.headers[X-Username]. Puede seleccionar de una lista de variables de contexto de uso común o introducir una variable de contexto de su elección. No preceda a la variable de contexto con un símbolo $ ni la incluya entre corchetes (como haría si estuviera agregando la variable de contexto a una URL en una especificación de despliegue de API en un archivo JSON). Para obtener más información, consulte Notas sobre la personalización de claves de caché.
4. Si desea almacenar en caché las respuestas de las solicitudes que contienen una cabecera de autorización o que contienen un parámetro de cabecera o consulta identificado en una política de autenticación, seleccione la opción Respuestas de Caché con Cabeceras de Autorización.

   Tenga en cuenta que el almacenamiento en caché de respuestas para dichas solicitudes puede comprometer la seguridad de los datos. Para obtener más información, consulte Notas sobre el almacenamiento en caché de respuestas para solicitudes que contienen credenciales (almacenamiento en caché privado).

5. Seleccione Siguiente para revisar los detalles introducidos para el despliegue de API.
6. Seleccione Crear o Guardar cambios para crear o actualizar el despliegue de API.
7. (Opcional) Confirme que la API se ha desplegado correctamente llamándola. Para ello, consulte Llamada a una API desplegada en un gateway de API.

Para agregar el almacenamiento en caché de respuesta a una ruta determinada, debe agregar una política de solicitud y una política de respuesta.

Para agregar la solicitud de almacenamiento en caché de respuesta y la política de respuesta a una especificación de despliegue de API en un archivo JSON:

1. Con su editor de JSON preferido, edite la especificación de despliegue de API existente a la que desea agregar el almacenamiento en caché de respuesta o cree una nueva especificación de despliegue de API (consulte Creación de una especificación de despliegue de API).

   Por ejemplo, la siguiente especificación básica de despliegue de API define una función sencilla de Hello World sin servidor en OCI Functions como un único backend:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

2. Para especificar la solicitud de almacenamiento en caché de respuesta y la política de respuesta que se aplica a una ruta individual:

   1. Introduzca una sección requestPolicies y una sección responsePolicies después de la sección de backend para la ruta a la que desea aplicar la política. Por ejemplo:

      {
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "requestPolicies": {},
            "responsePolicies": {}
          }
        ]
      }

   2. Agregue la siguiente política de solicitud responseCacheLookup a la nueva sección requestPolicies para aplicarla a la ruta:

      {
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "requestPolicies": {
              "responseCacheLookup": {
                "type": "SIMPLE_LOOKUP_POLICY",
                "isEnabled": true,
                "isPrivateCachingEnabled": <true|false>,
                "cacheKeyAdditions": [<list-of-context-variables>]
              }
            },
            "responsePolicies": {}
          }
        ]
      }

      donde:

      • "type": "SIMPLE_LOOKUP_POLICY" es el tipo de almacenamiento en caché de respuesta que se va a implantar. Actualmente sólo está soportada "SIMPLE_LOOKUP_POLICY".
      • "isEnabled": true indica que el almacenamiento en caché de respuesta está activado para la ruta. Si desea desactivar temporalmente el almacenamiento en caché de respuesta, defina "isEnabled": false. Si no se especifica, el valor por defecto es true.
      • "isPrivateCachingEnabled": <true|false> indica si se deben almacenar en caché las respuestas de las solicitudes que contienen una cabecera de autorización o que contienen una cabecera o un parámetro de consulta identificado en una política de autenticación. Tenga en cuenta que el almacenamiento en caché de respuestas para dichas solicitudes puede comprometer la seguridad de los datos. Si no se especifica, el valor por defecto es false, lo que indica que las respuestas para dichas solicitudes no se almacenan en caché. Para obtener más información, consulte Notas sobre el almacenamiento en caché de respuestas para solicitudes que contienen credenciales (almacenamiento en caché privado).
      • "cacheKeyAdditions": [<list-of-context-variables>] es una lista opcional separada por comas de variables de contexto que se agregarán a la clave de caché por defecto para asociar más estrechamente una respuesta almacenada en caché a una solicitud concreta. Por ejemplo, "cacheKeyAdditions": ["request.headers[Accept]"]. No anteponga un símbolo $ a la variable de contexto ni la incluya entre corchetes (como lo haría si estuviera agregando la variable de contexto a una URL en una especificación de despliegue de API en un archivo JSON). Para obtener más información, consulte Notas sobre la Personalización de Claves de Caché.
   3. Agregue la siguiente política de respuesta responseCacheStorage a la nueva sección responsePolicies para aplicarla a la ruta:

      {
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "requestPolicies": {
              "responseCacheLookup": {
                "type": "SIMPLE_LOOKUP_POLICY",
                "isEnabled": true,
                "isPrivateCachingEnabled": false,
                "cacheKeyAdditions": ["request.headers[Accept]"]
              }
            },
            "responsePolicies": {
              "responseCacheStorage": {
                "type": "FIXED_TTL_STORE_POLICY",
                "timeToLiveInSeconds": <seconds>
              }
            }
          }
        ]
      }

      donde:

      • "type": "FIXED_TTL_STORE_POLICY" es el tipo de caché de respuesta en la que se almacenan las respuestas. Actualmente sólo está soportada "FIXED_TTL_STORE_POLICY".
      • "timeToLiveInSeconds": <seconds> especifica el tiempo que los datos almacenados en caché están disponibles en el servidor de caché para esta ruta concreta. Por ejemplo, "timeToLiveInSeconds": 300

   Por ejemplo:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         },
         "requestPolicies": {
           "responseCacheLookup": {
             "type": "SIMPLE_LOOKUP_POLICY",
             "isEnabled": true,
             "isPrivateCachingEnabled": false,
             "cacheKeyAdditions": ["request.headers[Accept]"]
           }
         },
         "responsePolicies": {
           "responseCacheStorage": {
             "type":"FIXED_TTL_STORE_POLICY",
             "timeToLiveInSeconds": 300
           }
         }
       }
     ]
   }

3. Guarde el archivo JSON que contiene la especificación de despliegue de API.

4. Utilice la especificación de despliegue de API al crear o actualizar un despliegue de API de las siguientes formas:

   • Especificando el archivo JSON en la consola al seleccionar la opción Cargar API.
   • Especificando el archivo JSON en una solicitud para la API REST de gateway de API.

   Para obtener más información, consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API y Actualización de un gateway de API.

5. (Opcional) Confirme que la API se ha desplegado correctamente llamándola. Para ello, consulte Llamada a una API desplegada en un gateway de API.