Aggiungi il criterio SpikeArrest all'API

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Cosa imparerai a fare

Tramite questo tutorial imparerai a:

  • Aggiungi un criterio che influisce sulla richiesta e sulla risposta.
  • Vedi gli effetti delle norme.

Che cosa ti serve

  • Un'installazione Apigee. Vedi Panoramica e prerequisiti.
  • Un proxy API funzionante con almeno un criterio collegato. Consulta la pagina Creare il primo proxy API.
  • Un client API HTTP installato sulla tua macchina per effettuare chiamate API. Gli esempi di tutorial utilizzano curl.

Aggiungi il criterio SpikeArrest

In questo tutorial aggiungerai e configurerai il criterio SpikeArrest per proteggere il servizio di destinazione da picchi di traffico improvvisi che possono essere causati da un aumento dell'utilizzo, client con bug o attacchi dannosi. Quando il numero di richieste supera il limite di frequenza, l'API restituisce un errore HTTP 429.

Nuovo editor proxy

Per aggiungere il criterio SpikeArrest a un proxy API:

  1. Se utilizzi la UI di Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.

    Se utilizzi la UI di Apigee classica: seleziona Sviluppo > Proxy API e, nel riquadro Proxy, seleziona l'ambiente per il proxy.

    Se hai seguito il tutorial iniziale, puoi aggiungerlo al proxy API che hai creato nella sezione Creare un proxy API.

  2. Fai clic sulla scheda Sviluppo.
  3. Nel riquadro a sinistra, fai clic sul pulsante + nella riga Norme.

  4. Nella finestra di dialogo Crea criterio, fai clic nel campo Seleziona il tipo di criterio e scorri verso il basso fino a Gestione del traffico, quindi seleziona SpikeArrest.

  5. Se vuoi, puoi modificare il Nome e il Nome visualizzato del criterio. Per impostazione predefinita, Apigee fornisce un breve prefisso per il nome del criterio, in questo caso SA-. Puoi aggiungere una sequenza di parole descrittive, separate da trattini, dopo il prefisso. Consulta le convenzioni di denominazione.

    Finestra di dialogo Crea criterio.

    Quando hai finito, fai clic su Crea per creare la norma.

Ora che hai creato il criterio Spike Arrest, puoi aggiungerlo a un passaggio nel PreFlow.

  1. Seleziona Proxy Endpoints > default > PreFlow nel riquadro a sinistra:

    Seleziona gli endpoint di destinazione per PreFlow in Proxy Explorer.

    Nota:per visualizzare tutti gli elementi, potrebbe essere necessario espandere l'editor visivo nel riquadro a destra. A questo scopo, fai clic e trascina leggermente il divisore tra l'editor visivo e l'editor di testo.

  2. Fai clic sul pulsante + accanto a PreFlow nel riquadro Risposta in basso a destra nell'editor visivo:

    Fai clic sul pulsante + accanto a PreFlow nel riquadro Risposta.

  3. Nella finestra di dialogo Aggiungi criterio, seleziona il criterio Arresto picco.

  4. Fai clic su Aggiungi per allegare il criterio.

    Il criterio Arresto improvviso è ora visualizzato nel riquadro Risposta:

    Criterio di arresto dei picchi visualizzato nel riquadro Risposta.

Ora che hai collegato il criterio Spike Arrest a PreFlow, puoi provare a modificare il codice del criterio:

  1. Nel riquadro Risposta, seleziona SA-.

    Criterio di arresto dei picchi visualizzato nella scheda Criteri.

  2. L'editor di testo visualizza il codice XML per il proxy, incluso il passaggio del criterio Spike Arrest nell'elemento Response di 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. Nel codice XML del criterio, modifica il valore dell'elemento <Rate> in 1pm (che si traduce in circa due richieste consentite ogni 60 secondi nel cloud).

    Puoi specificare la frequenza sotto forma di valore intero al minuto (pm) o al secondo (ps). Si tratta di un limite molto basso e viene utilizzato solo per questo tutorial, allo scopo di dimostrare il criterio. In genere, si imposta un limite molto più alto.

    Tieni presente che anche il valore Rate nella finestra Controllo proprietà diventa 1pm. In alternativa, puoi modificare il valore Tariffa nel Controllo proprietà che verrà riportato nella visualizzazione XML.

  4. Fai clic su Salva per salvare la revisione corrente con le modifiche.

Editor proxy classico

Per aggiungere il criterio SpikeArrest a un proxy API:

  1. Accedi alla UI di Apigee.
  2. Seleziona Develop > API Proxy nella barra di navigazione a sinistra.
  3. Seleziona il proxy API a cui vuoi aggiungere il criterio SpikeArrest.

    Se hai seguito il tutorial iniziale, puoi aggiungerlo al proxy API che hai creato nella sezione Creare un proxy API.

  4. Nell'editor del nuovo proxy API, fai clic sulla scheda Sviluppo:

    La scheda Sviluppo si trova tra le schede Panoramica e Trace.

    L'editor proxy API consente di visualizzare la struttura del proxy API e di configurarne il flusso. L'editor presenta una rappresentazione visiva del flusso di messaggi di richiesta e risposta del proxy, nonché una visualizzazione modificabile del codice XML sottostante che definisce il proxy.

  5. Nel riquadro di navigazione a sinistra, fai clic su PreFlow in Endpoint del proxy > predefiniti. Altri tutorial tratteranno il concetto di flussi.
  6. Fai clic sul pulsante +Step in alto, corrispondente a Request PreFlow. Viene visualizzato un elenco categorizzato di tutti i criteri che puoi creare.

    Fai clic su Step in Request PreFlow.

  7. Seleziona SpikeArrest nella categoria Gestione del traffico. Viene visualizzata la finestra di dialogo Nuovo criterio:

    Creazione del criterio SpikeArrest.

  8. Lascia i nomi predefiniti e fai clic su Aggiungi. Il nuovo criterio è collegato al flusso PreFlow di una richiesta.
  9. Nel navigatore, assicurati che PreFlow in Proxy Endpoints > default sia ancora selezionato e prendi nota di quanto segue nell'API Proxy Editor:
    • Il nuovo criterio SpikeArrest-1 viene aggiunto nella sezione Criteri del riquadro di navigazione sul lato sinistro dell'editor del proxy API.
    • L'icona SpikeArrest-1 viene aggiunta alla vista Designer in alto al centro dell'API Proxy Editor, che è una rappresentazione visiva dei flussi di messaggi del proxy.
    • Il codice XML per il criterio viene visualizzato nella Vista codice in basso al centro dell'Editor proxy API.

    Visualizza PreFlow con il criterio SpikeArrest.

  10. Nel riquadro di navigazione, seleziona SpikeArrest-1 nella sezione Criteri e tieni presente quanto segue nell'Editor proxy API:
    • I dettagli del criterio vengono visualizzati nella vista Designer in alto al centro dell'editor proxy API.
    • Il codice XML per il criterio viene visualizzato nella Vista codice in basso al centro dell'editor proxy API.
    • I valori degli attributi e degli elementi XML del criterio vengono visualizzati in Proprietà sul lato destro dell'editor proxy API.

    Il riquadro Controllo proprietà mostra i valori del criterio SpikeArrest-1.

  11. Nel codice XML del criterio, modifica il valore dell'elemento <Rate> in 1pm (che si traduce in circa due richieste consentite ogni 60 secondi nel cloud).

    Puoi specificare la frequenza sotto forma di valore intero al minuto (pm) o al secondo (ps). Si tratta di un limite molto basso e viene utilizzato solo per questo tutorial, allo scopo di dimostrare il criterio. In genere, si imposta un limite molto più alto.

    Tieni presente che anche il valore Rate nella finestra Controllo proprietà diventa 1pm. In alternativa, puoi modificare il valore Tariffa nel Controllo proprietà che verrà riportato nella visualizzazione XML.

  12. Fai clic su Salva per salvare la revisione corrente con le modifiche.
  13. Esegui il deployment delle modifiche utilizzando il pulsante Esegui il deployment in:.

  14. Chiama l'API utilizzando curl, utilizzando l'URL del tuo dominio:

    curl "http://YOUR_DOMAIN/myproxy"

    dove:

    Per maggiori informazioni, consulta la pagina Testare il proxy API.

    Assicurati che la richiesta abbia esito positivo e che visualizzi la stessa risposta XML di prima. Puoi anche inserire solo l'URL in un browser web.

    Ora prova a testare l'impostazione Rate in diversi modi:

    • Esegui il comando curl (o aggiorna la finestra del browser) altre due o tre volte in un minuto e vedrai il seguente messaggio perché hai superato il limite di frequenza del criterio: 
      {
"fault": {
  "faultstring":"Spike arrest violation. Allowed rate : 1pm",
  "detail": {
    "errorcode":"policies.ratelimit.SpikeArrestViolation"}
  }
}

      Se tenti di effettuare altre chiamate entro un minuto, continuerai a ricevere il messaggio di errore.

    • Modifica il criterio per impostare il limite <Rate> su 15pm (che si traduce in circa due chiamate consentite ogni quattro secondi nel cloud), quindi salva ed esegui il deployment del proxy API.
    • Esegui il comando curl o aggiorna il browser ripetutamente (curl è più veloce). Tieni presente che se effettui una o due chiamate entro intervalli di quattro secondi, le chiamate avranno esito positivo. Se effettui le chiamate rapidamente, più di due in quattro secondi, dovresti ricevere l'errore di errore. Tuttavia, dopo ogni intervallo di 4 secondi puoi continuare a effettuare chiamate, anziché essere bloccato per un minuto intero (con l'impostazione 1pm).