Aggiungi il criterio SpikeArrest all'API

Nuovo editor proxy

Per aggiungere il criterio SpikeArrest a un proxy API:

1. Se utilizzi l'interfaccia utente di Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.

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

   Se hai seguito il tutorial Inizia, puoi aggiungerlo al proxy API creato in Crea 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 sul campo Seleziona il tipo di criterio, scorri verso il basso fino a Gestione del traffico e 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 la pagina Convenzioni di denominazione.

   

   Al termine, fai clic su Crea per creare il criterio.

Ora che hai creato il criterio di arresto dei picchi, puoi aggiungerlo a un passaggio nel PreFlow.

1. Seleziona Endpoint del proxy > predefinito > PreFlow nel riquadro a sinistra:

   

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

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

   

3. Nella finestra di dialogo Aggiungi passaggio del criterio, seleziona il criterio Arresto di picche.

4. Fai clic su Aggiungi per allegare il criterio.

   Il criterio Spike Arrest è ora visualizzato nel riquadro Response (Risposta):

   

Ora che hai associato il criterio Spike Arrest al preFlow, puoi provare a modificare il codice per il criterio:

1. Nel riquadro Risposta, seleziona SA-.

   

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 come valore intero al minuto (pm) o al secondo (ps). Questo è un limite molto basso e viene utilizzato solo per questo tutorial al fine di dimostrare il criterio. In genere, lo imposti su un limite molto più alto.

   Tieni presente che anche il valore Rate nel Controllo proprietà diventa 1pm. In alternativa, puoi modificare il valore della tariffa in Controllo proprietà e verrà applicato nella vista 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 all'UI di Apigee.
2. Seleziona Sviluppo > Proxy API nella barra di navigazione a sinistra.
3. Seleziona il proxy API a cui vuoi aggiungere il criterio SpikeArrest.

   Se hai seguito il tutorial Inizia, puoi aggiungerlo al proxy API creato in Crea un proxy API.

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

   

   L'editor del 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 proxy > default. (Altri tutorial tratteranno il concetto di flussi.)
6. Fai clic sul pulsante +Passaggio in alto, corrispondente al PreFlow della richiesta. Viene visualizzato un elenco categorizzato di tutti i criteri che puoi creare.

   

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

   

8. Lascia i nomi predefiniti e fai clic su Aggiungi. Il nuovo criterio è associato al flusso PreFlow di una richiesta.
9. Nel navigatore, assicurati che sia ancora selezionato PreFlow in Endpoint del proxy > predefiniti e tieni presente quanto segue nell'editor proxy API:
   • Il nuovo criterio SpikeArrest-1 viene aggiunto in Criteri nel 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'editor proxy API, 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.

   

10. Nel navigatore, seleziona SpikeArrest-1 in Criteri e prendi nota di quanto segue nell'editor del proxy API:
    • I dettagli del criterio sono riportati nella visualizzazione 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.
    • L'elemento XML e i valori degli attributi del criterio vengono visualizzati in Property Inspector sul lato destro dell'editor proxy API.

    

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 come valore intero al minuto (pm) o al secondo (ps). Questo è un limite molto basso e viene utilizzato solo per questo tutorial al fine di dimostrare il criterio. In genere, lo imposti su un limite molto più alto.

    Tieni presente che anche il valore Rate nel Controllo proprietà diventa 1pm. In alternativa, puoi modificare il valore della tariffa in Controllo proprietà e verrà applicato nella vista 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:

    • ENV_GROUP_HOSTNAME è il nome host del gruppo di ambienti che hai impostato durante il provisioning.
    • DOMAIN_HOSTNAME è il nome host del tuo dominio.

    Per maggiori informazioni, consulta Testare il proxy API.

    Assicurati che la richiesta vada a buon fine e che la risposta XML venga visualizzata come in precedenza. Puoi anche inserire solo l'URL in un browser web.

    A questo punto, 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 che viene visualizzato 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 provi a effettuare altre chiamate entro un minuto, continuerai a ricevere il messaggio di errore.

    • Modifica il criterio per impostare il limite <Rate> su 15pm (che corrisponde a 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 a intervalli di 4 secondi, le chiamate hanno esito positivo. Se effettui le chiamate rapidamente, più di due in quattro secondi, dovresti visualizzare l'errore. Tuttavia, dopo ogni intervallo di 4 secondi puoi continuare a effettuare chiamate, invece di rimanere bloccato per un intero minuto (con l'impostazione 1pm).