Prepara un palco per un REST API in API Gateway

Una fase è un riferimento denominato a una distribuzione, che è un'istantanea diAPI. Utilizzare una Stage (Fase) per gestire e ottimizzare una specifica distribuzione. Ad esempio, puoi configurare le impostazioni di fase per abilitare la memorizzazione nella cache, personalizzare il throttling della richiesta, configurare la registrazione, definire le variabili di fase o collegare una release Canary a scopi di test. La sezione seguente mostra come creare e configurare lo stage.

Creazione di una nuova fase

Dopo la distribuzione iniziale, puoi aggiungere altre fasi e associarle alle distribuzioni esistenti. È possibile utilizzare la console API Gateway per creare una nuova fase oppure scegliere una fase esistente durante la distribuzione di unaAPI. In generale, è possibile aggiungere una nuova fase a una API distribuzione prima di ridistribuire il. API Per creare una nuova fase utilizzando la console API Gateway, procedi nel seguente modo:

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

2. Scegli un RESTAPI.

3. Nel riquadro di navigazione principale, scegli Fasi sotto unAPI.

4. Dal riquadro di navigazione Fasi scegli Crea fase.

5. Per Nome fase immetti un nome, ad esempio prod.

   Nota

   I nomi di fasi possono contenere solo caratteri alfanumerici, trattini e caratteri di sottolineatura. La lunghezza massima è 128 caratteri.

6. (Facoltativo). In Descrizione inserisci una breve descrizione.

7. Per Distribuzione, seleziona la data e l'ora della API distribuzione esistente che desideri associare a questa fase.

8. In Impostazioni aggiuntive puoi specificare le impostazioni aggiuntive per la fase.

9. Scegli Crea fase.

Modifica le impostazioni della fase

Dopo una corretta implementazione di unAPI, lo stage viene popolato con le impostazioni predefinite. È possibile utilizzare la console o il API Gateway REST API per modificare le impostazioni dello stage, incluse la memorizzazione nella API cache e la registrazione. I passaggi seguenti mostrano come eseguire questa operazione utilizzando l'editor Stage della console API Gateway.

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

2. Scegli un RESTAPI.

3. Nel riquadro di navigazione principale, scegli Fasi sotto unAPI.

4. Nel riquadro Stages (Fasi), selezionare il nome della fase.

5. Nella sezione Dettagli fase scegli Modifica.

6. (Facoltativo) In Descrizione fase modifica la descrizione.

7. In Impostazioni aggiuntive modifica le seguenti impostazioni:

   Impostazioni cache

   Per abilitare la API memorizzazione nella cache per lo stage, attiva Provision API cache. Quindi configura la memorizzazione nella cache a livello di metodo predefinita, la capacità della cache, la crittografia dei dati della cache, Cache time-to-live (TTL) e tutti i requisiti per l'invalidazione della cache per chiave.

   La memorizzazione nella cache non è attiva finché non attivi la cache a livello di metodo predefinita o non attivi la cache a livello di metodo per un metodo specifico.

   Per ulteriori informazioni sulle impostazioni della cache, consulta Impostazioni della cache per le API REST in API Gateway.

   Nota

   Se abiliti la API memorizzazione nella cache per una API fase, il costo della memorizzazione nella cache potrebbe essere addebitato al tuo account AWS . API La memorizzazione nella cache non è idonea per il piano gratuito AWS .

   Impostazioni di limitazione (della larghezza di banda della rete)

   Per impostare obiettivi di limitazione a livello di fase per tutti i metodi associati, attiva Throttling. API

   Per Rate(Tasso), inserire un tasso di destinazione. Questa è la velocità, espressa in richieste al secondo, con cui i token vengono aggiunti al bucket di token. La velocità a livello di fase non deve essere superiore alla velocità a livello di account come specificato in APIQuote del gateway per la configurazione e l'esecuzione di un REST API.

   Per Burst (ottimizzazione), inserisci un tasso di destinazione. La frequenza di burst è la capacità del token bucket. Ciò consente di passare più richieste per un periodo di tempo rispetto al tasso di destinazione. Questo tasso di ottimizzazione a livello di fase non deve essere superiore al tasso di ottimizzazione a livello di account come specificato in APIQuote del gateway per la configurazione e l'esecuzione di un REST API.

   Nota

   I tassi di limitazione (della larghezza di banda della rete) non sono limiti rigidi e vengono applicati sulla base del miglior tentativo. In alcuni casi, i client possono superare gli obiettivi impostati. Non fare affidamento sulla limitazione per controllare i costi o bloccare l'accesso a un. API Prendi in considerazione l'utilizzo Budget AWSper monitorare i costi e AWS WAFgestire le API richieste.

   Impostazioni di firewall e certificati

   Per associare un AWS WAF Web ACL allo stage, selezionate un Web ACL dall'elenco a ACL discesa Web. Se lo desideri, scegli Blocca API richiesta se il Web ACL non può essere valutato (Fail-Close).

   Per selezionare un certificato client per la fase, scegli un certificato dal menu a discesa Certificati client.

8. Selezionare Salva.

9. Per abilitare Amazon CloudWatch Logs per tutti i metodi associati a questa fase di questo API gatewayAPI, nella sezione Logs and tracing, scegli Modifica.

   Nota

   Per abilitare CloudWatch i log, devi anche specificare il IAM ruolo che consente a API Gateway ARN di scrivere informazioni nei CloudWatch log per conto del tuo utente. A tale scopo, scegli Impostazioni dal pannello di navigazione APIsprincipale. Quindi, per il ruolo di CloudWatch registro, inserisci il ARN di un IAM ruolo.

   Per gli scenari applicativi più comuni, il IAM ruolo potrebbe allegare la policy gestita diAmazonAPIGatewayPushToCloudWatchLogs, che contiene la seguente dichiarazione sulla politica di accesso:

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Effect": "Allow",
               "Action": [
                   "logs:CreateLogGroup",
                   "logs:CreateLogStream",
                   "logs:DescribeLogGroups",
                   "logs:DescribeLogStreams",
                   "logs:PutLogEvents",
                   "logs:GetLogEvents",
                   "logs:FilterLogEvents"
               ],
               "Resource": "*"
           }
       ]
   }

   Il IAM ruolo deve contenere anche la seguente dichiarazione di relazione di fiducia:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Sid": "",
         "Effect": "Allow",
         "Principal": {
           "Service": "apigateway.amazonaws.com"
         },
         "Action": "sts:AssumeRole"
       }
     ]
   }

   Per ulteriori informazioni CloudWatch, consulta la Amazon CloudWatch User Guide.

10. Seleziona un livello di registrazione dal menu a discesa CloudWatch Logs. I livelli di registrazione sono i seguenti:

    • Disattivata: la registrazione non è attivata per questa fase.

    • Solo errori: la registrazione è abilitata solo per gli errori.

    • Errori e registri delle informazioni: la registrazione è abilitata per tutti gli eventi.

    • Registri completi delle richieste e delle risposte: la registrazione dettagliata è abilitata per tutti gli eventi. Questo può essere utile per la risoluzione dei problemiAPIs, ma può comportare la registrazione di dati sensibili.

      Nota

      Si consiglia di non utilizzare i registri completi di richieste e risposte per la produzione. APIs

11. Seleziona Metriche dettagliate per fare in modo che API Gateway CloudWatch riferisca alle API metriche diAPI calls,, LatencyIntegration latency, 400 errors e. 500 errors Per ulteriori informazioni CloudWatch, consulta il monitoraggio di base e il monitoraggio dettagliato nella Amazon CloudWatch User Guide.

    Importante

    Al tuo account viene addebitato l'accesso alle metriche a livello di metodo, ma non alle CloudWatch metriche a livello o a API livello di fase.

12. Per abilitare la registrazione degli accessi a una destinazione, attiva Registrazione accesso personalizzato.

13. Per la destinazione del registro di accesso ARN, immettete un gruppo ARN di log o uno stream Firehose.

    Il ARN formato per Firehose è. arn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name} Il nome dello stream Firehose deve essere. amazon-apigateway-{your-stream-name}

14. In Formato log immetti un formato di log. Per ulteriori informazioni sui formati di log di esempio, consulta CloudWatch formati di registro per API Gateway.

15. Per abilitare il AWS X-Raytracciamento per lo API stage, selezionate Tracciamento X-Ray. Per ulteriori informazioni, consulta Traccia le richieste degli utenti sulle API REST utilizzando X-Ray in API Gateway.

16. Seleziona Save changes (Salva modifiche). Ridistribuite le vostre API per rendere effettive le nuove impostazioni.

Sostituzione delle impostazioni a livello di fase

Dopo aver personalizzato le impostazioni a livello di stage, potete sostituirle per ogni metodo. API Alcune di queste opzioni potrebbero comportare costi aggiuntivi per il tuo. Account AWS

1. Per configurare le sostituzioni dei metodi, espandi la fase nel pannello di navigazione secondario, quindi scegli un metodo.

   

2. Per Sostituzioni del metodo scegli Modifica.

3. Per attivare CloudWatch le impostazioni a livello di metodo, per CloudWatch Registri, seleziona un livello di registrazione.

4. Per attivare i parametri dettagliati a livello di metodo, seleziona Parametri dettagliati. Al tuo account viene addebitato l'accesso alle metriche a livello di metodo, ma non alle CloudWatch metriche a livello o a livello di fase. API

5. Per attivare la limitazione (della larghezza di banda della rete) a livello di metodo, seleziona Throttling. Immetti le opzioni appropriate a livello di metodo. Per ulteriori informazioni sulla limitazione, consulta Limita le richieste alle tue API REST per una migliore velocità di trasmissione in API Gateway.

6. Per configurare la cache a livello di metodo, seleziona Abilita cache dei metodi. Se modificate l'impostazione predefinita della memorizzazione nella cache a livello di metodo nei dettagli dello stage, ciò non influisce su questa impostazione.

7. Selezionare Salva.