Mantieni un piano di utilizzo per REST APIs in API Gateway

La gestione di un piano di utilizzo implica il monitoraggio delle quote utilizzate e rimanenti in un determinato periodo di tempo, se necessario, e l'estensione delle quote rimanenti di una quantità specificata. Le procedure seguenti descrivono come monitorare le quote.

AWS Management Console

Per monitorare le quote utilizzate e rimanenti

1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Nel riquadro di navigazione principale di Gateway API, scegli Piani di utilizzo.

3. Seleziona un piano di utilizzo.

4. Scegli la scheda Chiavi API associate per visualizzare il numero di richieste rimanenti per il periodo di tempo per ciascuna chiave.

5. (Facoltativo) Scegli Esporta dati di utilizzo, quindi scegli una data in Da e una data in A. Quindi, scegli JSON o CSV per il formato dei dati esportati e infine scegli Esporta.

   L'esempio di seguito mostra un file esportato.

   {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     }

   I dati di utilizzo nell'esempio mostrano i dati di utilizzo per un client API identificato dalla chiave API (px1KW6...qBazOJH) tra il 1 e il 3 agosto 2016. I dati di utilizzo giornalieri mostrano le quote utilizzate e rimanenti. In questo esempio il sottoscrittore non ha ancora usato le quote riservate e l'amministratore o il proprietario dell'API ha ridotto la quota rimanente da 5000 a 10 il terzo giorno.

Le procedure seguenti descrivono come modificare le quote.

Per estendere le quote rimanenti

1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Nel riquadro di navigazione principale di Gateway API, scegli Piani di utilizzo.

3. Seleziona un piano di utilizzo.

4. Scegli la scheda Chiavi API associate per visualizzare il numero di richieste rimanenti per il periodo di tempo per ciascuna chiave.

5. Seleziona una chiave API, quindi scegli Concedi estensione utilizzo.

6. Immetti un numero di quote in Richieste rimanenti. Puoi aumentare o diminuire le richieste rimanenti per il periodo di validità del tuo piano di utilizzo.

7. Scegli Aggiorna quota.

AWS CLI

I seguenti update-usage-planesempi aggiungono, rimuovono o modificano le impostazioni di limitazione a livello di metodo in un piano di utilizzo.

Nota

Assicurarsi di modificare us-east-1 nel valore di regione appropriato per l'API.

Per aggiungere o sostituire un limite di tasso per il throttling di una risorsa e un metodo singoli:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/rateLimit",value="0.1"

Per aggiungere o sostituire un limite di ottimizzazione per il throttling di una risorsa e un metodo singoli:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/burstLimit",value="1"

Per rimuovere le impostazioni di throttling a livello di metodo per una risorsa e un metodo singoli:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod",value=""

Per rimuovere tutte le impostazioni di throttling a livello di metodo per un'API:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle ",value=""

Di seguito è riportato un esempio utilizzando l'API di esempio Pet Store:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle",value='"{\"/pets/GET\":{\"rateLimit\":1.0,\"burstLimit\":1},\"//GET\":{\"rateLimit\":1.0,\"burstLimit\":1}}"'

REST API

Chiama usageplan:updateper mantenere un piano di utilizzo.