Mise en cache des réponses pour améliorer les performances

Pour activer et configurer la mise en mémoire cache des réponses pour une passerelle d'API à l'aide de la console :

1. Créez ou mettez à jour une passerelle d'API à l'aide de la console.

   Pour plus d'informations, voir Création d'une passerelle d'API et Mise à jour d'une passerelle d'API.

2. Dans la section Options avancées de la boîte de dialogue Créer une passerelle, sélectionnez le bouton Activer à côté de Mise en cache des réponses et :

   1. Spécifiez les options du serveur de mémoire cache, comme suit :
      • Hôte : Nom d'hôte du serveur de mémoire cache. Par exemple, "cache.example.com".
      • Numéro de port : Numéro de port sur le serveur de mémoire cache. Par exemple : 6379.
   2. Spécifiez les options Données d'identification du serveur de mémoire cache, comme suit :
      • Chambre forte : Nom de la chambre forte dans le service de chambre forte qui contient les données d'identification pour la connexion au serveur de mémoire cache.
      • Clé secrète de la chambre forte : Nom de la clé secrète dans la chambre forte spécifiée qui contient les données d'identification pour la connexion au serveur de mémoire cache.
      • Numéro de version de la clé secrète de la chambre forte : Version de la clé secrète à utiliser.
   3. Spécifiez les options de connexion au serveur de mémoire cache, comme suit :
      • Utiliser SSL/TLS dans les demandes : Indique si le serveur de mémoire cache est activé pour TLS et, par conséquent, s'il faut configurer une connexion sécurisée entre la passerelle d'API et le serveur de mémoire cache sur TLS (anciennement SSL).
      • Vérifier le certificat SSL/TLS : Indique si la passerelle d'API vérifie le certificat TLS du serveur de mémoire cache (anciennement SSL). Notez que seuls les certificats signés par les autorités de certification publiques sont actuellement vérifiés.
      • Temporisation de la connexion : Durée d'attente avant d'abandonner une tentative de connexion au serveur de mémoire cache, en millisecondes. Si la passerelle d'API ne peut pas se connecter au serveur de cache pendant ce temps, la passerelle d'API n'extrait pas les données précédemment mises en cache à partir du serveur de cache et n'écrit pas de nouvelles données sur le serveur de cache pour une réutilisation future potentielle.
      • Temporisation de lecture : Durée d'attente avant d'abandonner une tentative de lecture des données à partir du serveur de mémoire cache, en millisecondes. Si la passerelle d'API ne peut pas extraire les données du serveur de mémoire cache pendant ce temps, elle envoie plutôt une demande au service dorsal.
      • Temporisation d'envoi : Durée d'attente avant d'abandonner une tentative d'écriture de données sur le serveur de mémoire cache, en millisecondes. Si la passerelle d'API ne peut pas envoyer de données au serveur de cache dans ce délai, aucune réponse n'est mise en mémoire cache pour une réutilisation future potentielle.
3. Sélectionnez Créer ou enregistrer les modifications pour créer ou mettre à jour la passerelle d'API.

Pour activer et configurer la mise en mémoire cache des réponses pour une passerelle d'API à l'aide de l'interface de ligne de commande et d'un fichier JSON :

1. Dans votre éditeur JSON préféré, créez un fichier de configuration de cache dans le format suivant :

   {
     "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>
   }

   où :

   • "type" : "EXTERNAL_RESP_CACHE" indique que la mise en mémoire cache des réponses doit être activée. Si elle n'est pas définie, la valeur par défaut est "type" : "NONE", ce qui indique que la mise en mémoire cache des réponses est désactivée.
   • "host" : "<cache-server-hostname>" est le nom d'hôte du serveur de mémoire cache. Par exemple, "host" : "cache.example.com".
   • "port" : <port-number> est le numéro de port sur le serveur de mémoire cache. Par exemple, "port" : 6379.
   • "authenticationSecretId" : "<secret-ocid>" est l'OCID de la clé secrète définie dans une chambre forte du service de chambre forte qui contient les données d'identification pour la connexion au serveur de mémoire cache. Par exemple, "authenticationSecretId" : "ocid.oc1.sms.secret.aaaaaa______gbdn"
   • "authenticationSecretVersionNumber" : <secret-version-number> est la version de la clé secrète à utiliser. Par exemple, "authenticationSecretVersionNumber" : 1
   • "isSSLEnabled" : <true|false> indique si le serveur de mémoire cache est activé pour TLS et, par conséquent, s'il faut configurer une connexion sécurisée entre la passerelle d'API et le serveur de mémoire cache sur TLS (anciennement SSL). Si aucune valeur n'est définie, la valeur par défaut est false
   • "isSSLVerifyDisabled" : <true|false> indique si la passerelle d'API vérifie le certificat TLS (anciennement SSL) du serveur de mémoire cache. Notez que seuls les certificats signés par les autorités de certification publiques sont actuellement vérifiés. Si aucune valeur n'est définie, la valeur par défaut est false
   • "connectTimeoutInMs" : <milliseconds> indique le délai d'attente avant d'abandonner une tentative de connexion au serveur de mémoire cache, en millisecondes. Si la passerelle d'API ne peut pas se connecter au serveur de cache pendant ce temps, la passerelle d'API n'extrait pas les données précédemment mises en cache à partir du serveur de cache et n'écrit pas de nouvelles données sur le serveur de cache pour une réutilisation future potentielle. Si elle n'est pas définie, la valeur par défaut est 1000. Par exemple, "connectTimeoutInMs" : 1500
   • "readTimeoutInMs" : <milliseconds> indique le délai d'attente avant d'abandonner une tentative de lecture des données à partir du serveur de mémoire cache, en millisecondes. Si la passerelle d'API ne peut pas extraire les données du serveur de mémoire cache pendant ce temps, elle envoie plutôt une demande au service dorsal. Si elle n'est pas définie, la valeur par défaut est 1000. Par exemple, "readTimeoutInMs" : 250
   • "sendTimeoutInMs" : <milliseconds> indique le délai d'attente avant d'abandonner une tentative d'écriture de données sur le serveur de mémoire cache, en millisecondes. Si la passerelle d'API ne peut pas envoyer de données au serveur de mémoire cache dans ce délai, les réponses ne sont pas mises en mémoire cache pour une réutilisation future potentielle. Si elle n'est pas définie, la valeur par défaut est 1000. Par exemple, "sendTimeoutInMs" : 1250

   Par exemple :

   {
     "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. Enregistrez le fichier de configuration de la mémoire cache avec le nom de votre choix. Par exemple, resp-cache-config.json
3. Utilisez le fichier de configuration de la mémoire cache lorsque vous créez ou mettez à jour une passerelle d'API à l'aide de l'interface de ligne de commande :
   • Pour créer une passerelle d'API avec la mise en mémoire cache des réponses activée, suivez les instructions de l'interface de ligne de commande sous Création d'une passerelle d'API et réglez le paramètre --response-cache-details au nom et à l'emplacement du fichier de configuration de la mémoire cache. Par exemple :

     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

   • Pour mettre à jour une passerelle d'API existante afin d'activer la mise en mémoire cache des réponses ou de modifier les paramètres de mise en mémoire cache des réponses, suivez les instructions de l'interface de ligne de commande sous Mise à jour d'une passerelle d'API et réglez le paramètre --response-cache-details au nom et à l'emplacement du fichier de configuration de la mémoire cache. Par exemple :

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

Pour ajouter des politiques de demande et de réponse de mise en mémoire cache de réponses à une spécification de déploiement d'API à l'aide de la console :

1. Créez ou mettez à jour un déploiement d'API à l'aide de la console, sélectionnez l'option À partir de zéro et entrez les détails dans la page Informations de base.

   Pour plus d'informations, voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API et Mise à jour d'une passerelle d'API.

2. Sélectionnez Suivant pour entrer les détails de chaque route du déploiement d'API dans la page Routes et sélectionnez Mise en mémoire cache des réponses.

3. Sélectionnez l'option Mise en mémoire cache pour cette route et spécifiez les options de mise en mémoire cache des réponses qui s'appliquent à cette route particulière :
   • TTL (Time To Live) pour les réponses en mémoire cache en secondes : Durée de disponibilité des données en mémoire cache dans le serveur de mémoire cache pour cette route particulière.
   • Ajouts de clé en mémoire cache : Une ou plusieurs variables de contexte à ajouter à la clé de mémoire cache par défaut pour associer plus étroitement une réponse en mémoire cache à une demande particulière. Par exemple, request.headers[X-Username]. Vous pouvez effectuer une sélection dans une liste de variables de contexte couramment utilisées ou entrer une variable de contexte de votre choix. Ne pas précéder la variable de contexte d'un symbole $ ou la placer entre accolades (comme vous le feriez si vous ajoutez la variable de contexte à une URL dans une spécification de déploiement d'API dans un fichier JSON). Pour plus d'informations, voir Notes sur la personnalisation des clés de mémoire cache.
4. Si vous voulez mettre en mémoire cache les réponses pour les demandes qui contiennent un en-tête d'autorisation, ou qui contiennent un en-tête ou un paramètre d'interrogation identifié dans une politique d'authentification, sélectionnez l'option Mettre en mémoire cache les réponses avec des en-têtes d'autorisation.

   Notez que la mise en mémoire cache des réponses pour de telles demandes peut compromettre la sécurité des données. Pour plus d'informations, voir Notes sur la mise en mémoire cache des réponses pour les demandes contenant des données d'identification (mise en mémoire cache privée).

5. Sélectionnez Suivant pour vérifier les détails que vous avez entrés pour le déploiement d'API.
6. Sélectionnez Créer ou enregistrer les modifications pour créer ou mettre à jour le déploiement d'API.
7. (Facultatif) Vérifiez que l'API a été déployée avec succès en l'appelant (voir Appel d'une API déployée sur une passerelle d'API).

Pour ajouter la mise en mémoire cache des réponses à une route particulière, vous devez ajouter à la fois une politique de demande et une politique de réponse.

Pour ajouter une demande de mise en mémoire cache de réponses et une politique de réponse à une spécification de déploiement d'API dans un fichier JSON :

1. Dans votre éditeur JSON préféré, modifiez la spécification de déploiement d'API existante à laquelle vous souhaitez ajouter la mise en mémoire cache de réponse ou créez une spécification de déploiement d'API (voir Création d'une spécification de déploiement d'API).

   Par exemple, la spécification de déploiement d'API de base suivante définit une simple fonction sans serveur Hello World du service des fonctions pour OCI en tant qu'élément dorsal unique :

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

2. Pour spécifier la demande de mise en mémoire cache de réponses et la politique de réponse qui s'appliquent à une route individuelle :

   1. Ajoutez à la fois une section requestPolicies et une section responsePolicies après la section dorsale pour la route à laquelle appliquer la politique. Par exemple :

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

   2. Ajoutez la politique de demande responseCacheLookup suivante à la nouvelle section requestPolicies pour l'application à la route :

      {
        "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": {}
          }
        ]
      }

      où :

      • "type": "SIMPLE_LOOKUP_POLICY" est le type de mise en mémoire cache des réponses à mettre en oeuvre. Seule "SIMPLE_LOOKUP_POLICY" est actuellement prise en charge.
      • "isEnabled": true indique que la mise en mémoire cache des réponses est activée pour la route. Si vous voulez désactiver temporairement la mise en mémoire cache des réponses, définissez "isEnabled": false. Si vous ne spécifiez pas de valeur, la valeur par défaut est true.
      • "isPrivateCachingEnabled": <true|false> indique s'il faut mettre en mémoire cache les réponses pour les demandes qui contiennent un en-tête d'autorisation, ou qui contiennent un en-tête ou un paramètre d'interrogation identifié dans une politique d'authentification. Notez que la mise en mémoire cache des réponses pour de telles demandes peut compromettre la sécurité des données. Si elle n'est pas spécifiée, la valeur par défaut est false, ce qui indique que les réponses pour ces demandes ne sont pas mises en mémoire cache. Pour plus d'informations, voir Notes sur la mise en mémoire cache des réponses pour les demandes contenant des données d'identification (mise en mémoire cache privée).
      • "cacheKeyAdditions": [<list-of-context-variables>] est une liste facultative de variables de contexte séparées par des virgules à ajouter à la clé de mémoire cache par défaut pour associer plus étroitement une réponse en mémoire cache à une demande particulière. Par exemple, "cacheKeyAdditions": ["request.headers[Accept]"]. Ne pas précéder la variable de contexte d'un symbole $ ou la placer entre accolades (comme vous le feriez si vous ajoutez la variable de contexte à une URL dans une spécification de déploiement d'API dans un fichier JSON). Pour plus d'informations, voir Notes sur la personnalisation des clés de mémoire cache.
   3. Ajoutez la politique de réponse responseCacheStorage suivante à la nouvelle section responsePolicies à appliquer à la route :

      {
        "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>
              }
            }
          }
        ]
      }

      où :

      • "type": "FIXED_TTL_STORE_POLICY" est le type de mémoire cache de réponses dans lequel stocker les réponses. Seule "FIXED_TTL_STORE_POLICY" est actuellement prise en charge.
      • "timeToLiveInSeconds": <seconds> indique la durée pendant laquelle les données en mémoire cache sont disponibles dans le serveur de mémoire cache pour cette route particulière. Par exemple, "timeToLiveInSeconds": 300

   Par exemple :

   {
     "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. Enregistrez le fichier JSON contenant la spécification de déploiement d'API.

4. Utilisez comme suit la spécification de déploiement d'API lorsque vous créez ou mettez à jour un déploiement d'API :

   • En spécifiant le fichier JSON dans la console lorsque vous sélectionnez l'option Charger une API existante.
   • En spécifiant le fichier JSON dans une demande à l'API REST du service Passerelle d'API.

   Pour plus d'informations, voir Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API et Mise à jour d'une passerelle d'API.

5. (Facultatif) Vérifiez que l'API a été déployée avec succès en l'appelant (voir Appel d'une API déployée sur une passerelle d'API).