SpikeArrest-Richtlinie in die API einfügen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Lerninhalte

In dieser Anleitung lernen Sie Folgendes:

  • Sie fügen eine Richtlinie hinzu, die die Anfrage und die Antwort beeinflusst.
  • Sie sehen die Auswirkungen der Richtlinie.

Voraussetzungen

  • Eine Apigee-Installation. Weitere Informationen zu Übersicht und Voraussetzungen.
  • Einen funktionierenden API-Proxy, dem mindestens eine Richtlinie angehängt ist. Weitere Informationen zu Ersten API-Proxy erstellen.
  • Auf Ihrem Computer installierter HTTP-API-Client für API-Aufrufe. In den Beispielen der Anleitung wird curl verwendet.

SpikeArrest-Richtlinie hinzufügen

In diesem Tutorial fügen Sie die Spike Arrest-Richtlinie hinzu und konfigurieren sie, um den Zieldienst vor plötzlichen Traffic-Spitzen zu schützen, die durch einen Anstieg der Nutzung, fehlerhafte Clients oder böswillige Angriffe verursacht werden können. Wenn die Anzahl der Anfragen die Ratenbegrenzung überschreitet, gibt die API den HTTP-Fehler 429 zurück.

Um die die SpikeArrest-Richtlinie einem API-Proxy hinzuzufügen:

  1. Rufen Sie in der Google Cloud Console die Seite Apigee > Proxy-Entwicklung > API-Proxys auf.

    Zu „API-Proxys“

    Wenn Sie der Anleitung "Erste Schritte" gefolgt sind, können Sie sie dem API-Proxy hinzufügen, den Sie unter API-Proxy erstellen angelegt haben.

  2. Klicken Sie auf den Tab Entwickeln.
  3. Klicken Sie im linken Bereich in der Zeile Richtlinien auf die Schaltfläche +.
  4. Klicken Sie im Dialogfeld Richtlinie erstellen in das Feld Richtlinientyp auswählen und scrollen Sie nach unten zu Trafficverwaltung und wählen Sie Spike Arrest.

  5. Optional können Sie den Namen und den Anzeigenamen der Richtlinie ändern. Standardmäßig stellt Apigee ein kurzes Präfix für den Richtliniennamen bereit, in diesem Fall SA-. Sie können eine Folge von beschreibenden Wörtern hinzufügen, die durch Bindestriche getrennt sind. Siehe Namenskonventionen.

    Erstellen Sie den "Richtlinie erstellen"-Dialog.

    Wenn Sie fertig sind, klicken Sie auf Erstellen, um die Richtlinie zu erstellen.

Da Sie nun die Spike Arrest-Richtlinie erstellt haben, können Sie sie einem Schritt im PreFlow hinzufügen.

  1. Wählen Sie im linken Bereich Proxy-Endpunkte > Standard > PreFlow:

    Wählen Sie Zielendpunkte für PreFlow im Proxy-Explorer aus.

    Hinweis: Möglicherweise müssen Sie den visuellen Editor im rechten Bereich erweitern, um alle Elemente anzuzeigen. Klicken Sie dazu auf die Trennlinie zwischen dem visuellen Editor und dem Texteditor.

  2. Klicken Sie auf die Schaltfläche + neben PreFlow im Antwortbereich unten rechts im visuellen Editor:

    Klicken Sie im Antwortbereich neben PreFlow auf die Schaltfläche "+".

  3. Wählen Sie im Dialogfeld Add policy step die Spike Arrest-Richtlinie.
  4. Klicken Sie auf Hinzufügen, um die Richtlinie anzuhängen.

    Die Richtlinie Spike Arrest wird jetzt im Bereich Antwort angezeigt:

    Richtlinie "Spike Arrest" im Antwortbereich.

Nachdem Sie die Spike Arrest-Richtlinie an den PreFlow angehängt haben, können Sie versuchen, den Code für die Richtlinie zu ändern:

  1. Wählen Sie im Bereich Antwort die Option SA- aus.

    Die Spike Arrest-Richtlinie wird auf dem Tab "Richtlinien" angezeigt.

  2. Im Texteditor wird der XML-Code für den Proxy angezeigt, einschließlich des Spike Arrest-Richtlinienschritts im Element Antwort des PreFlow.
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <SpikeArrest continueOnError="false" enabled="true" name="SA-">
        <DisplayName>SA-</DisplayName>
        <Properties/>
        <Identifier ref="request.header.some-header-name"/>
        <MessageWeight ref="request.header.weight"/>
        <Rate>30ps</Rate>
    </SpikeArrest>
  3. Ändern Sie in der XML-Richtlinie für die Richtlinie den Wert des Elements <Rate> in 1pm, was ungefähr zwei Anfragen pro 60 Sekunden in der Cloud entspricht.

    Sie können die Rate als Ganzzahlwert pro Minute (pm) oder pro Sekunde (ps) angeben. Dies ist ein sehr geringes Limit und wird nur für diese Anleitung verwendet, um die Richtlinie zu veranschaulichen. In der Regel legen Sie dafür einen viel höheren Grenzwert fest.

    Beachten Sie, dass sich der Wert Rate im Property-Prüftool auch in 1pm ändert. Alternativ können Sie den Wert Rate im Property Inspector ändern, der dann in der XML-Ansicht angezeigt wird.

  4. Klicken Sie auf Speichern, um die aktuelle Überarbeitung mit Ihren Änderungen zu speichern.