Configurer une scène pour un REST API in API Gateway - APIPasserelle Amazon
Création d'une étapeMise à jour des paramètres d'étapeRemplacement des paramètres au niveau de l’étape

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configurer une scène pour un REST API in API Gateway

Une étape est une référence nommée à un déploiement, qui est un instantané duAPI. Vous utilisez une Stage (Étape) pour gérer et optimiser un déploiement spécifique. Par exemple, vous pouvez configurer les paramètres d'une étape pour activer la mise en cache, personnaliser la limitation des requêtes, configurer la journalisation, définir des variables d'étapes ou attacher une version Canary à des fins de test. La section suivante explique comment créer et configurer votre scène.

Création d'une étape

Après le déploiement initial, vous pouvez ajouter d'autres étapes et les associer à des déploiements existants. Vous pouvez utiliser la console API Gateway pour créer une nouvelle étape, ou vous pouvez choisir une étape existante lors du déploiement d'uneAPI. En général, vous pouvez ajouter une nouvelle étape à un API déploiement avant de redéployer leAPI. Pour créer une nouvelle étape à l'aide de la console API Gateway, procédez comme suit :

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

  2. Choisissez un RESTAPI.

  3. Dans le volet de navigation principal, choisissez Stages sous unAPI.

  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 API déploiement existant que vous souhaitez 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.

Modifier les paramètres de scène

Après le déploiement réussi d'unAPI, le stage est renseigné avec les paramètres par défaut. Vous pouvez utiliser la console ou la API passerelle REST API pour modifier les paramètres de l'étape, notamment la API mise en cache et la journalisation. Les étapes suivantes vous montrent comment procéder à l'aide de l'éditeur Stage de la console API Gateway.

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

  2. Choisissez un RESTAPI.

  3. Dans le volet de navigation principal, choisissez Stages sous unAPI.

  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 API mise en cache pour la phase, activez Provisionner le API cache. 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 REST APIs in API Gateway.

    Note

    Si vous activez la API mise en cache pour une API étape, la mise en API cache 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 des cibles de régulation au niveau de l'étape pour toutes les méthodes associéesAPI, activez la régulation.

    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 APIQuotas de passerelle pour configurer et exécuter un REST API.

    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 APIQuotas de passerelle pour configurer et exécuter un REST API.

    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 vous fiez pas à la régulation pour contrôler les coûts ou bloquer l'accès à un. API Envisagez AWS Budgetsde l'utiliser pour surveiller les coûts et AWS WAFgérer les API demandes.

    Paramètres du pare-feu et des certificats

    Pour associer un AWS WAF site Web ACL à la scène, sélectionnez-le dans la liste ACL déroulante Web. ACL Si vous le souhaitez, choisissez Block API Request si le Web ACL ne peut pas être évalué (Fail-Close).

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

  8. Choisissez Continuer.

  9. Passez en revue vos modifications et choisissez Enregistrer les modifications.

  10. Pour activer Amazon CloudWatch Logs pour toutes les méthodes associées à cette étape de cette API passerelleAPI, dans la section Journaux et suivi, sélectionnez Modifier.

    Note

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

    Pour les scénarios d'application courants, le IAM rôle peut associer la stratégie gérée deAmazonAPIGatewayPushToCloudWatchLogs, qui contient l'énoncé de politique d'accès suivant :

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

    Le IAM rôle doit également contenir la déclaration de relation de confiance 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.

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

  12. Sélectionnez Suivi des données pour que API Gateway fasse rapport à CloudWatch l'enregistrement du suivi des données de votre étape. Cela peut être utile pour résoudre les problèmesAPIs, mais peut entraîner l'enregistrement de données sensibles.

    Note

    Nous vous recommandons de ne pas utiliser le suivi des données pour la productionAPIs.

  13. Sélectionnez Mesures détaillées pour que API Gateway produise un rapport CloudWatch sur les API mesures 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 la méthode ou API au niveau de l'étape.

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

  15. Pour la destination du journal Access ARN, entrez le nom ARN d'un groupe de journaux ou d'un flux Firehose.

    Le ARN format de 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}

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

  17. Pour activer le AWS X-Raytraçage pour la API scène, sélectionnez X-Ray Tracing. Pour de plus amples informations, veuillez consulter Suivez les demandes des utilisateurs vers les API REST à l'aide de X-Ray dans API Gateway.

  18. Sélectionnez Save Changes (Enregistrer les modifications). Redéployez votre API pour que les nouveaux paramètres prennent effet.

Remplacement des paramètres au niveau de l’étape

Après avoir personnalisé les paramètres au niveau de l'étape, vous pouvez les remplacer pour chaque méthode. API Certaines de ces options peuvent entraîner des frais supplémentaires pour votre Compte AWS.

  1. Pour configurer les remplacements de méthode, développez l’étape sous le volet de navigation secondaire, puis choisissez une 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 l'enregistrement du suivi des données pour votre méthode, sélectionnez Suivi des données.

    Note

    Nous vous recommandons de ne pas utiliser le suivi des données pour la productionAPIs.

  5. 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 la méthode ou API au niveau de l'étape.

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

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

  8. Choisissez Save (Enregistrer).