Configuration d'une étape à l'aide de la console API Gateway

1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

2. Choisissez une API REST.

3. Dans le volet de navigation principal, choisissez Étapes sous une API.

4. Dans le volet de navigation Étapes, choisissez Créer une étape.

5. Pour Nom de l'étape, entrez un nom, par exemple prod.

   Note

   Les noms d'étape peuvent contenir uniquement des caractères alphanumériques, des tirets et des traits de soulignement. La longueur maximale est de 128 caractères.

6. (Facultatif) Pour Description, entrez une brève description.

7. Pour Déploiement, sélectionnez la date et l'heure du déploiement d'API existant que vous voulez associer à cette étape.

8. Sous Paramètres supplémentaires, vous pouvez définir des paramètres supplémentaires pour votre étape.

9. Choisissez Créer une étape.

1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

2. Choisissez une API REST.

3. Dans le volet de navigation principal, choisissez Étapes sous une API.

4. Dans le volet Stages, choisissez le nom de l'étape.

5. Dans la section Détails de l'étape, choisissez Modifier.

6. (Facultatif) Pour Description de l’étape, modifiez la description.

7. Pour Paramètres supplémentaires, vous modifiez les paramètres suivants :

   Paramètres du cache

   Pour activer la mise en cache des API pour la phase, activez le cache de l'API Provisionner. Configurez ensuite la mise en cache au niveau de la méthode par défaut, la capacité du cache, le chiffrement des données du cache, le cache time-to-live (TTL), ainsi que les exigences relatives à l'invalidation du cache par clé.

   La mise en cache n'est active que lorsque vous activez la mise en cache par défaut au niveau de la méthode ou que vous activez le cache au niveau de la méthode pour une méthode spécifique.

   Pour plus d’informations sur les paramètres de cache, consultez Paramètres de cache pour les API REST dans API Gateway.

   Note

   Si vous activez la mise en cache d'API pour une étape d'API, la mise en cache d'API peut être facturée sur votre AWS compte. La mise en cache n'est pas éligible au niveau AWS gratuit.

   Paramètres de limitation

   Pour définir les cibles de limitation au niveau de l’étape pour toutes les méthodes associées à cette API, activez Limitation.

   Pour Rate (Taux), entrez un taux cible. Il s’agit du taux, en requêtes par seconde, auquel les jetons sont ajoutés au compartiment de jetons. Ce taux au niveau de l’étape ne doit pas être supérieur au taux au niveau du compte, comme indiqué dans Quotas API Gateway pour la configuration et l'exécution d'une API REST.

   Pour Rafale, entrez un taux de rafale cible. Le taux de rafale correspond à la capacité du compartiment de jetons. Cela permet de passer plus de demandes pendant une période de temps que le taux cible. Ce taux en rafale au niveau de l'étape doit pas être supérieur au taux en rafale au niveau du compte, comme indiqué dans Quotas API Gateway pour la configuration et l'exécution d'une API REST.

   Note

   Les limites des taux de limitation ne sont pas strictes et sont appliquées au mieux. Dans certains cas, les clients peuvent dépasser les quotas que vous avez définis. Ne comptez pas sur la limitation pour contrôler les coûts ou bloquer l'accès à une API. Pensez à utiliser AWS Budgets pour contrôler les coûts et AWS WAF pour gérer les demandes d'API.

   Paramètres du pare-feu et des certificats

   Pour associer une ACL AWS WAF Web à la scène, sélectionnez une ACL Web dans la liste déroulante Web ACL. Si vous le souhaitez, choisissez Block API Request if WebACL cannot be evaluated (Fail- Close) (Bloquer la demande d'API si la liste ACL web ne peut pas être évaluée (Échec - Fermeture)).

   Pour sélectionner un certificat client pour votre étape, sélectionnez-le dans le menu déroulant Certificat de client.

8. Choisissez Enregistrer.

9. Pour activer Amazon CloudWatch Logs pour toutes les méthodes associées à cette étape de cette API API Gateway, dans la section Journaux et suivi, choisissez Modifier.

   Note

   Pour activer CloudWatch les journaux, vous devez également spécifier l'ARN d'un rôle IAM qui permet à API Gateway d'écrire des informations dans CloudWatch les journaux au nom de votre utilisateur. Pour ce faire, choisissez Settings dans le volet de navigation principal APIs. Ensuite, pour le rôle CloudWatch log, entrez l'ARN d'un rôle IAM.

   Pour les scénarios d'application courants, le rôle IAM pourrait attacher la stratégie gérée AmazonAPIGatewayPushToCloudWatchLogs, qui contient la déclaration de stratégie d'accès suivante :

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

   Le rôle IAM doit également contenir la déclaration de relation d'approbation suivante :

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

   Pour plus d'informations CloudWatch, consultez le guide de CloudWatch l'utilisateur Amazon.

10. Sélectionnez un niveau de journalisation dans le menu déroulant CloudWatch Logs. Les niveaux de journalisation sont les suivants :

    • Désactivé — La journalisation n'est pas activée pour cette étape.

    • Erreurs uniquement : la journalisation n'est activée que pour les erreurs.

    • Journaux d'erreurs et d'informations : la journalisation est activée pour tous les événements.

    • Journaux complets des demandes et des réponses : la journalisation détaillée est activée pour tous les événements. Cela peut être utile pour dépanner les API, mais peut entraîner la consignation de données sensibles.

      Note

      Nous vous recommandons de ne pas utiliser les Journaux complets des requêtes et des réponses pour les API de production.

11. Sélectionnez les métriques détaillées pour qu'API Gateway produise un rapport CloudWatch sur les métriques d'API de API callsLatency,Integration latency,400 errors, et500 errors. Pour plus d'informations CloudWatch, consultez les sections Surveillance de base et surveillance détaillée dans le guide de CloudWatch l'utilisateur Amazon.

    Important

    Votre compte est débité pour accéder aux métriques au niveau de la méthode, mais pas aux CloudWatch métriques au niveau de l'API ou au niveau de l'étape.

12. Pour activer la journalisation des accès à une destination, activez Journalisation des accès personnalisée.

13. Pour l'ARN de destination du journal Access, entrez l'ARN d'un groupe de journaux ou d'un flux Firehose.

    Le format ARN pour Firehose est. arn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name} Le nom de votre stream Firehose doit être. amazon-apigateway-{your-stream-name}

14. Dans Format de journal, entrez un format de journal. Pour en savoir plus sur les exemples de formats de journal, consultez CloudWatch formats de journal pour API Gateway.

15. Pour activer le suivi AWS X-Ray pour l'étape d'API, sélectionnez Suivi X-Ray. Pour plus d’informations, consultez Suivez les demandes des utilisateurs vers les API REST à l'aide de X-Ray dans API Gateway.

16. Choisissez Enregistrer les modifications. Redéployez votre API pour que les nouveaux paramètres prennent effet.

Pour mettre à jour des paramètres au niveau de l’étape à l’aide de la console API Gateway

1. Pour configurer les remplacements de méthode, développez l’étape sous le volet de navigation secondaire, puis choisissez une méthode.

   

2. Ensuite, pour Remplacements de méthode, choisissez Modifier.

3. Pour activer les CloudWatch paramètres au niveau de la méthode, pour CloudWatch Logs, sélectionnez un niveau de journalisation.

4. Pour activer les métriques détaillées au niveau de la méthode, sélectionnez Métriques détaillées. Votre compte est débité pour accéder aux métriques au niveau de la méthode, mais pas aux CloudWatch métriques au niveau de l'API ou au niveau de l'étape.

5. Pour activer la limitation au niveau de la méthode, sélectionnez Limitation. Saisissez les options appropriées au niveau de la méthode. Pour en savoir plus sur la limitation, consultez Limitez les demandes adressées à vos API REST pour améliorer le débit dans API Gateway.

6. Pour configurer le cache au niveau de la méthode, sélectionnez Activer le cache de méthode. Si vous modifiez le paramètre de mise en cache par défaut au niveau de la méthode dans les détails de l'étape, cela n'affecte pas ce paramètre.

7. Choisissez Enregistrer.

1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

2. Choisissez une API REST.

3. Dans le volet de navigation principal, choisissez Étapes.

4. Dans le volet Étapes, sélectionnez l'étape à supprimer, puis choisissez Actions d'étape et Supprimer une étape.

5. Lorsque vous y êtes invité, entrez confirm, puis choisissez Supprimer.