Maintenir un plan d'utilisation pour REST APIs dans API Gateway

La gestion d’un plan d’utilisation implique la surveillance des quotas utilisés et restants sur une période donnée et, si besoin, l’extension des quotas restants selon une valeur spécifiée. Les procédures suivantes expliquent comment surveiller les quotas.

AWS Management Console

Pour surveiller les quotas utilisés et restants

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

2. Dans le panneau de navigation principal d'API Gateway, choisissez Plans d'utilisation.

3. Sélectionnez un plan d'utilisation.

4. Choisissez l'onglet Clés d'API associées pour voir le nombre de demandes restantes pendant la période de temps pour chaque clé.

5. (Facultatif) Choisissez Exporter les données d’utilisation, puis choisissez une date de début De et une date de fin À. Choisissez ensuite JSON ou CSV pour le format des données exportées, puis choisissez Exporter.

   L’exemple suivant montre un fichier exporté.

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

   Les données d’utilisation de cet exemple présentent les données d’utilisation quotidiennes d’un client d’API, identifié par la clé d’API (px1KW6...qBazOJH), entre le 1er août 2016 et le 3 août 2016. Les données d’utilisation de chaque jour montrent les quotas utilisés et restants. Dans cet exemple, l’abonné n’a pas encore commencé à utiliser ses quotas alloués et le propriétaire ou l’administrateur de l’API a réduit le quota restant de 5 000 à 10 le troisième jour.

Les procédures suivantes expliquent comment modifier les quotas.

Pour étendre les quotas restants

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

2. Dans le panneau de navigation principal d'API Gateway, choisissez Plans d'utilisation.

3. Sélectionnez un plan d'utilisation.

4. Choisissez l'onglet Clés d'API associées pour voir le nombre de demandes restantes pendant la période de temps pour chaque clé.

5. Sélectionnez une clé d’API, puis choisissez Accorder une extension d’utilisation.

6. Entrez un nombre pour définir le quota Demandes restantes. Vous pouvez augmenter ou réduire le nombre de demandes restantes pendant la durée de votre plan d’utilisation.

7. Choisissez Mettre à jour le quota.

AWS CLI

Les update-usage-planexemples suivants ajoutent, suppriment ou modifient les paramètres de régulation au niveau de la méthode dans un plan d'utilisation.

Note

Assurez-vous de remplacer us-east-1 par la région appropriée pour votre API.

Pour ajouter ou remplacer une limitation de taux afin de restreindre une ressource et une méthode en particulier :

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"

Pour ajouter ou remplacer une limitation du mode rafale afin de restreindre une ressource et une méthode en particulier :

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"

Pour supprimer les paramètres de limitation au niveau méthode pour une ressource et une méthode en particulier :

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=""

Pour supprimer tous les paramètres de limitation au niveau de la méthode pour une API :

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

Voici un extrait utilisant l’exemple d’API 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

Appelez usageplan:updatepour maintenir un plan d'utilisation.