Antworten zur Performanceverbesserung cachen

So aktivieren und konfigurieren Sie Antwort-Caching für ein API-Gateway mit der Konsole:

1. Erstellen oder aktualisieren Sie ein API-Gateway mit der Konsole.

   Weitere Informationen finden Sie unter API-Gateway erstellen und API-Gateway aktualisieren.

2. Wählen Sie im Dialogfeld Gateway erstellen im Abschnitt Erweiterte Optionen neben Antwort-Caching die Schaltfläche Aktivieren aus, und gehen Sie wie folgt vor:

   1. Geben Sie die Optionen für Cacheserver wie folgt an:
      • Host: Der Hostname des Cacheservers. Beispiel: "cache.example.com".
      • Portnummer: Die Portnummer auf dem Cacheserver. Beispiel: 6379.
   2. Geben Sie die Optionen für Cacheserverzugangsdaten wie folgt an:
      • Vault: Der Name des Vaults im Vault-Service, der die Zugangsdaten für die Anmeldung beim Cacheserver enthält.
      • Vault Secret: Der Name des Secrets im angegebenen Vault, der die Zugangsdaten für die Anmeldung beim Cacheserver enthält.
      • Vault-Secret-Versionsnummer: Die Version des zu verwendenden Secrets.
   3. Geben Sie die Optionen für Cacheserververbindung wie folgt an:
      • SSL/TLS in Anforderungen verwenden: Gibt an, ob der Cacheserver TLS-fähig ist und daher eine sichere Verbindung zwischen dem API-Gateway und dem Cacheserver über TLS (früher SSL) eingerichtet werden soll.
      • SSL/TLS-Zertifikat prüfen: Gibt an, ob das API-Gateway das TLS-(früher SSL-)Zertifikat des Cacheservers prüft. Beachten Sie, dass derzeit nur Zertifikate verifiziert werden, die von öffentlichen Zertifizierungsstellen signiert wurden.
      • Verbindungstimeout: Gibt an, wie lange es dauert, bis ein Verbindungsversuch zum Cacheserver abgebrochen wird (in Millisekunden). Wenn das API-Gateway innerhalb dieser Zeit keine Verbindung zum Cacheserver herstellen kann, ruft das API-Gateway zuvor gecachte Daten nicht vom Cacheserver ab und schreibt keine neuen Daten für eine mögliche zukünftige Wiederverwendung in den Cacheserver.
      • Lesetimeout: Wartezeit, bevor ein Versuch abgebrochen wird, Daten vom Cacheserver zu lesen, in Millisekunden. Wenn das API-Gateway innerhalb dieser Zeit keine Daten vom Cacheserver abrufen kann, sendet das API-Gateway stattdessen eine Anforderung an den Backend-Service.
      • Sendtimeout: Gibt an, wie lange es dauert, bis ein Versuch abgebrochen wird, Daten in Millisekunden in den Cacheserver zu schreiben. Wenn das API-Gateway innerhalb dieser Zeit keine Daten an den Cacheserver senden kann, wird keine Antwort für eine mögliche zukünftige Wiederverwendung im Cache gespeichert.
3. Wählen Sie Erstellen oder Änderungen speichern aus, um das API-Gateway zu erstellen oder zu aktualisieren.

So aktivieren und konfigurieren Sie Antwortcaching für ein API-Gateway mit der CLI und einer JSON-Datei:

1. Erstellen Sie mit Ihrem bevorzugten JSON-Editor eine Cachekonfigurationsdatei in folgendem Format:

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

   Dabei gilt:

   • "type" : "EXTERNAL_RESP_CACHE" gibt an, dass das Antwort-Caching aktiviert werden soll. Wenn diese Option nicht festgelegt ist, lautet der Standardwert "type" : "NONE", was darauf hinweist, dass das Antwort-Caching deaktiviert ist.
   • "host" : "<cache-server-hostname>" ist der Hostname des Cacheservers. Beispiel: "host" : "cache.example.com".
   • "port" : <port-number> ist die Portnummer auf dem Cacheserver. Beispiel: "port" : 6379.
   • "authenticationSecretId" : "<secret-ocid>" ist die OCID des Secrets, das in einem Vault im Vault-Service definiert ist und die Zugangsdaten für die Anmeldung beim Cacheserver enthält. Beispiel: "authenticationSecretId" : "ocid.oc1.sms.secret.aaaaaa______gbdn"
   • "authenticationSecretVersionNumber" : <secret-version-number> ist die Version des zu verwendenden Secrets. Zum Beispiel, "authenticationSecretVersionNumber" : 1
   • "isSSLEnabled" : <true|false> gibt an, ob der Cacheserver TLS-fähig ist und daher eine sichere Verbindung zwischen dem API-Gateway und dem Cacheserver über TLS (früher SSL) eingerichtet werden soll. Wenn diese Option nicht festgelegt ist, wird standardmäßig false verwendet.
   • "isSSLVerifyDisabled" : <true|false> gibt an, ob das API-Gateway das TLS-(früher SSL-)Zertifikat des Cacheservers prüft. Beachten Sie, dass derzeit nur Zertifikate überprüft werden, die von öffentlichen Zertifizierungsstellen signiert wurden. Wenn diese Option nicht festgelegt ist, wird standardmäßig false verwendet.
   • "connectTimeoutInMs" : <milliseconds> gibt an, wie lange gewartet werden muss, bevor ein Verbindungsversuch zum Cacheserver abgebrochen wird (in Millisekunden). Wenn das API-Gateway innerhalb dieser Zeit keine Verbindung zum Cacheserver herstellen kann, ruft das API-Gateway keine zuvor gecachten Daten vom Cacheserver ab und schreibt keine neuen Daten für eine mögliche zukünftige Wiederverwendung auf den Cacheserver. Wenn dies nicht festgelegt ist, lautet der Standardwert 1000. Zum Beispiel, "connectTimeoutInMs" : 1500
   • "readTimeoutInMs" : <milliseconds> gibt an, wie lange gewartet werden muss, bevor ein Versuch abgebrochen wird, Daten vom Cacheserver zu lesen, in Millisekunden. Wenn das API-Gateway innerhalb dieser Zeit keine Daten vom Cacheserver abrufen kann, sendet das API-Gateway stattdessen eine Anforderung an den Backend-Service. Wenn dies nicht festgelegt ist, lautet der Standardwert 1000. Zum Beispiel "readTimeoutInMs" : 250
   • "sendTimeoutInMs" : <milliseconds> gibt an, wie lange gewartet werden muss, bevor ein Versuch, Daten auf den Cacheserver zu schreiben, in Millisekunden abgebrochen wird. Wenn das API-Gateway innerhalb dieser Zeit keine Daten an den Cacheserver senden kann, werden Antworten nicht für eine potenzielle zukünftige Wiederverwendung gecacht. Wenn dies nicht festgelegt ist, lautet der Standardwert 1000. Zum Beispiel, "sendTimeoutInMs" : 1250

   Beispiel:

   {
     "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. Speichern Sie die Cachekonfigurationsdatei mit einem Namen Ihrer Wahl. Zum Beispiel, resp-cache-config.json
3. Verwenden Sie die Cachekonfigurationsdatei, wenn Sie ein API-Gateway mit der CLI erstellen oder aktualisieren:
   • Um ein neues API-Gateway mit aktiviertem Antwort-Caching zu erstellen, befolgen Sie die CLI-Anweisungen unter API-Gateway erstellen, und setzen Sie den Parameter --response-cache-details auf den Namen und den Speicherort der Cachekonfigurationsdatei. Beispiel:

     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

   • Um ein vorhandenes API-Gateway zu aktualisieren, um das Antwort-Caching zu aktivieren oder die Einstellungen für das Antwort-Caching zu ändern, befolgen Sie die CLI-Anweisungen unter API-Gateway aktualisieren, und setzen Sie den Parameter --response-cache-details auf den Namen und den Speicherort der Cachekonfigurationsdatei. Beispiel:

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

So fügen Sie mit der Konsole Antwort-Caching-Anforderungs- und Antwort-Policys zu einer API-Deployment-Spezifikation hinzu:

1. Erstellen oder aktualisieren Sie ein API-Deployment mit der Konsole, wählen Sie die Option Völlig neu aus, und geben Sie auf der Seite Basisinformationen Details ein.

   Weitere Informationen finden Sie unter API durch das Erstellen eines API-Deployment in einem API-Gateway bereitstellen und API-Gateway aktualisieren.

2. Wählen Sie Weiter aus, um Details zu einzelnen Routen im API-Deployment auf der Seite Routen einzugeben, und wählen Sie Antwort-Caching aus.

3. Wählen Sie die Option Caching für diese Route aus, und geben Sie die Antwort-Caching-Optionen an, die für diese bestimmte Route gelten:
   • TTL (Gültigkeitsdauer) für gecachte Antworten in Sekunden: Wie lange gecachte Daten auf dem Cacheserver für diese bestimmte Route verfügbar sind.
   • Schlüsselhinzufügungen cachen: Eine oder mehrere Kontextvariablen, die dem Standardcacheschlüssel hinzugefügt werden sollen, um eine gecachte Antwort enger mit einer bestimmten Anforderung zu verknüpfen. Beispiel: request.headers[X-Username]. Sie können aus einer Liste häufig verwendeter Kontextvariablen auswählen oder eine Kontextvariable Ihrer Wahl eingeben. Stellen Sie der Kontextvariablen kein Symbol "$" voran, oder setzen Sie sie in geschweifte Klammern (wie beim Hinzufügen der Kontextvariable zu einer URL in einer API-Deployment-Spezifikation in einer JSON-Datei). Weitere Informationen finden Sie unter Hinweise zum Anpassen von Cacheschlüsseln.
4. Wenn Sie Antworten für Anforderungen cachen möchten, die einen Autorisierungsheader enthalten oder einen Header oder Abfrageparameter enthalten, der in einer Authentifizierungs-Policy identifiziert ist, wählen Sie die Option Antworten mit Autorisierungsheadern cachen.

   Beachten Sie, dass das Caching von Antworten für solche Anforderungen die Datensicherheit beeinträchtigen kann. Weitere Informationen finden Sie unter Hinweise zum Caching von Antworten für Anforderungen mit Zugangsdaten (privates Caching).

5. Wählen Sie Weiter aus, um die Details zu prüfen, die Sie für das API-Deployment eingegeben haben.
6. Wählen Sie Erstellen oder Änderungen speichern aus, um das API-Deployment zu erstellen oder zu aktualisieren.
7. (Optional) Bestätigen Sie, dass die API erfolgreich bereitgestellt wurde, indem Sie sie aufrufen (siehe In einem API-Gateway bereitgestellte API aufrufen).

Um einer bestimmten Route Antwort-Caching hinzuzufügen, müssen Sie sowohl eine Anforderungs-Policy als auch eine Antwort-Policy hinzufügen.

So fügen Sie die Antwort-Caching-Anforderung und Antwort-Policy zu einer API-Deployment-Spezifikation in einer JSON-Datei hinzu:

1. Bearbeiten Sie mit Ihrem bevorzugten JSON-Editor die vorhandene API-Deployment-Spezifikation, der Sie Antwort-Caching hinzufügen möchten, oder erstellen Sie eine neue API-Deployment-Spezifikation (siehe API-Deployment-Spezifikation erstellen).

   Beispiel: Die folgende Basisspezifikation für das API-Deployment definiert eine einfache serverlose Hello World-Funktion in OCI Functions als einzelnes Backend:

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

2. So geben Sie die Antwort-Caching-Anforderung und Antwort-Policy an, die für eine einzelne Route gilt:

   1. Fügen Sie nach dem Backend-Abschnitt für die Route, auf die Sie die Policy anwenden möchten, sowohl einen requestPolicies-Abschnitt als auch einen responsePolicies-Abschnitt ein. Beispiel:

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

   2. Fügen Sie die folgende responseCacheLookup-Anforderungs-Policy zum neuen requestPolicies-Bereich hinzu, um sie auf die Route anzuwenden:

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

      Dabei gilt:

      • "type": "SIMPLE_LOOKUP_POLICY" ist der Typ des zu implementierenden Antwortcachings. Nur "SIMPLE_LOOKUP_POLICY" wird derzeit unterstützt.
      • "isEnabled": true gibt an, dass das Antwort-Caching für die Route aktiviert ist. Wenn Sie das Antwort-Caching vorübergehend deaktivieren möchten, setzen Sie "isEnabled": false. Wenn kein Wert angegeben wird, wird standardmäßig true verwendet.
      • "isPrivateCachingEnabled": <true|false> gibt an, ob Antworten für Anforderungen gecacht werden sollen, die einen Autorisierungsheader enthalten oder einen Header oder Abfrageparameter enthalten, der in einer Authentifizierungs-Policy identifiziert wird. Beachten Sie, dass das Caching von Antworten für solche Anforderungen die Datensicherheit beeinträchtigen kann. Wenn keine Angabe gemacht wird, lautet der Standardwert false, der angibt, dass Antworten für solche Anforderungen nicht im Cache gespeichert werden. Weitere Informationen finden Sie unter Hinweise zum Caching von Antworten für Anforderungen mit Zugangsdaten (privates Caching).
      • "cacheKeyAdditions": [<list-of-context-variables>] ist eine optionale kommagetrennte Liste von Kontextvariablen, die dem Standardcacheschlüssel hinzugefügt werden, um eine gecachte Antwort enger mit einer bestimmten Anforderung zu verknüpfen. Beispiel: "cacheKeyAdditions": ["request.headers[Accept]"]. Stellen Sie der Kontextvariablen kein $-Symbol voran, oder setzen Sie sie in geschweifte Klammern (wie Sie es tun würden, wenn Sie die Kontextvariable zu einer URL in einer API-Deployment-Spezifikation in einer JSON-Datei hinzufügen würden). Weitere Informationen finden Sie unter Hinweise zum Anpassen von Cacheschlüsseln.
   3. Fügen Sie die folgende responseCacheStorage-Antwort-Policy zum neuen responsePolicies-Abschnitt hinzu, der auf die Route angewendet werden soll:

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

      Dabei gilt:

      • "type": "FIXED_TTL_STORE_POLICY" ist der Typ des Antwortcaches, in dem Antworten gespeichert werden. Nur "FIXED_TTL_STORE_POLICY" wird derzeit unterstützt.
      • "timeToLiveInSeconds": <seconds> gibt an, wie lange zwischengespeicherte Daten auf dem Cacheserver für diese bestimmte Route verfügbar sind. Beispiel: "timeToLiveInSeconds": 300

   Beispiel:

   {
     "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. Speichern Sie die JSON-Datei, die die API-Deployment-Spezifikation enthält.

4. Verwenden Sie die API-Deployment-Spezifikation, wenn Sie ein API-Deployment wie folgt erstellen oder aktualisieren:

   • Durch Angabe der JSON-Datei in der Konsole bei Auswahl der Option Vorhandene API hochladen
   • Durch Angabe der JSON-Datei in einer Anforderung an die REST-API von API-Gateway

   Weitere Informationen finden Sie unter API durch das Erstellen eines API-Deployment in einem API-Gateway bereitstellen und API-Gateway aktualisieren.

5. (Optional) Bestätigen Sie, dass die API erfolgreich bereitgestellt wurde, indem Sie sie aufrufen (siehe In einem API-Gateway bereitgestellte API aufrufen).