Creazione, configurazione e test dei piani di utilizzo con la console API Gateway

Prima di creare un piano di utilizzo, accertati di avere configurato le chiavi API desiderate. Per ulteriori informazioni, consulta Impostare le chiavi API utilizzando la console API Gateway.

In questa sezione viene illustrato come creare e usare un piano di utilizzo mediante la console API Gateway.

Eseguire la migrazione dell'API a Piani di utilizzo predefiniti (se necessario)

Se hai iniziato a usare API Gateway dopo l'introduzione della caratteristica dei piani di utilizzo l'11 agosto 2016, troverai che i piani di utilizzo sono abilitati automaticamente in tutte le regioni supportate.

Se hai iniziato a utilizzare API Gateway prima di quella data, potrebbe essere necessario migrare ai piani di utilizzo predefiniti. Ti verrà proposta l'opzione Enable Usage Plans (Abilita piani di utilizzo) prima di usare i piani di utilizzo per la prima volta nella regione selezionata. Quando abiliti questa opzione, vengono creati piani di utilizzo predefiniti per ogni fase API univoca associata alle chiavi API esistenti. Nel piano di utilizzo predefinito, non vengono impostati inizialmente throttle o limiti di quota e le associazioni tra le chiavi API e le fasi API sono copiate sui piani di utilizzo. Il comportamento dell'API resta inalterato. Tuttavia, è necessario utilizzare la UsagePlanapiStagesproprietà per associare i valori di fase dell'API specificati (apiIdestage) alle chiavi API incluse (via UsagePlanKey), anziché utilizzare la ApiKeystageKeysproprietà.

Per controllare se hai già eseguito la migrazione ai piani di utilizzo predefiniti, utilizza il comando della CLI get-account. Nell'output del comando, l'elenco features include una voce "UsagePlans" quando i piani di utilizzo sono abilitati.

Puoi anche migrare le tue API ai piani di utilizzo predefiniti utilizzando AWS CLI quanto segue:

Per migrare ai piani di utilizzo predefiniti utilizzando AWS CLI

1. Invoca questo comando della CLI: update-account.

2. Per il parametro cli-input-json, utilizza il seguente JSON:

   [
       {
           "op": "add",
           "path": "/features",
           "value": "UsagePlans"
       }
   ]

Creazione di un piano di utilizzo

La procedura seguente illustra come creare un piano di utilizzo.

Per creare un piano di utilizzo

1. Accedere 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 e quindi Crea piano di utilizzo.

   

3. In Nome, immetti un nome.

4. (Facoltativo) In Description (Descrizione), immettere una descrizione.

5. Per impostazione predefinita, i piani di utilizzo abilitano la limitazione (della larghezza di banda della rete). Immetti un valore in Tariffa e Ottimizzazione per il tuo piano di utilizzo. Scegli Throttling per disattivare la limitazione (della larghezza di banda della rete).

6. Per impostazione predefinita, i piani di utilizzo abilitano una quota per un periodo di tempo. In Richieste, immetti il numero totale di richieste che un utente può effettuare nel periodo di validità del tuo piano di utilizzo. Scegli Quota per disattivare la quota.

7. Scegli Crea piano di utilizzo.

Aggiunta di una fase al piano di utilizzo

1. Seleziona il piano di utilizzo.

2. Nella scheda Fasi associate, scegli Aggiungi fase.

   

3. In API, seleziona un'API.

4. In Fase, seleziona una fase.

5. (Facoltativo) Per attivare la limitazione (della larghezza di banda della rete) a livello di metodo, esegui le operazioni indicate di seguito:

   1. Scegli Throttling a livello di metodo e quindi Aggiungi metodo.

   2. InRisorsa, seleziona una risorsa nella tua API.

   3. In Metodo, seleziona un metodo nella tua API.

   4. Immetti un valore in Tariffa e Ottimizzazione per il tuo piano di utilizzo.

6. Scegli Aggiungi al piano di utilizzo.

Aggiunta di una chiave al piano di utilizzo

1. Nella scheda Chiavi API associate, scegli Aggiungi chiave API.

   

2. 1. Per associare una chiave esistente al tuo piano di utilizzo, seleziona Aggiungi chiave esistente, quindi seleziona la chiave esistente nel menu a discesa.

   2. Per creare una nuova chiave API, seleziona Crea e aggiungi nuova chiave, quindi crea una nuova chiave. Per ulteriori informazioni su come creare una nuova chiave, consulta Creazione di una chiave API.

3. Scegli Aggiungi chiave API.

Test di un piano di utilizzo

Per testare il piano di utilizzo, puoi utilizzare un AWS SDK o un client API REST come Postman. AWS CLI Per un esempio di uso di Postman per testare il piano di utilizzo, consultare Test dei piani di utilizzo.

Gestione di un piano di utilizzo

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.

Per monitorare le quote utilizzate e rimanenti

1. Accedere 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.

   {
     "thisPeriod": {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     },
     "startDate": "2016-08-01",
     "endDate": "2016-08-03"
   }

   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. Accedere 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.