Création, configuration et test des plans d'utilisation avec la console API Gateway

Avant de créer un plan d'utilisation, assurez-vous d'avoir configuré les clés API souhaitées. Pour de plus amples informations, veuillez consulter Configuration des clés d'API à l'aide de la console API Gateway.

Cette section décrit comment créer et utiliser un plan d'utilisation à l'aide de la console API Gateway.

Migration de votre API vers les plans d'utilisation par défaut (si nécessaire)

Si vous avez commencé à utiliser API Gateway après le déploiement de la fonction des plans d'utilisation le 11 août 2016, les plans d'utilisation seront automatiquement activés dans toutes les régions prises en charge.

Si vous avez commencé à utiliser API Gateway avant cette date, vous devrez peut-être migrer vers les plans d'utilisation par défaut. Vous serez invité à définir l'option Enable Usage Plans (Activer les plans d'utilisation) avant d'utiliser des plans d'utilisation pour la première fois dans la région sélectionnée. Lorsque vous activez cette option, des plans d'utilisation par défaut sont créés pour chaque étape d'API unique associée aux clés API existantes. Dans le plan d'utilisation par défaut, aucune limitation ou limite de quota n'est définie initialement, et les associations entre les clés d'API et les étapes d'API sont copiées dans les plans d'utilisation. L'API se comporte de la même manière qu'auparavant. Toutefois, vous devez utiliser la UsagePlanapiStagespropriété pour associer les valeurs d'étape d'API spécifiées (apiIdetstage) aux clés d'API incluses (via UsagePlanKey), au lieu d'utiliser la ApiKeystageKeyspropriété.

Pour vérifier si vous avez déjà migré vers les plans d'utilisation par défaut, utilisez la commande CLI get-account. Dans la sortie de la commande, la liste features inclut une entrée de "UsagePlans" lorsque les plans d'utilisation sont activés.

Vous pouvez également migrer vos API vers des plans d'utilisation par défaut en utilisant AWS CLI ce qui suit :

Pour passer aux plans d'utilisation par défaut à l'aide du AWS CLI

1. Appelez cette commande CLI : update-account.

2. Pour le paramètre cli-input-json, utilisez le code JSON suivant :

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

Création d'un plan d'utilisation

La procédure suivante explique comment créer un plan d'utilisation.

Pour créer un plan d'utilisation

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

2. Dans le panneau de navigation principal d'Amazon API Gateway, choisissez Plans d'utilisation, puis Créer un plan d’utilisation.

   

3. Pour Nom, entrez un nom.

4. (Facultatif) Sous Description, entrez une description.

5. Par défaut, les plans d'utilisation permettent une limitation. Entrez un Taux et un Débit pour votre plan d'utilisation. Choisissez Limitation pour désactiver la limitation.

6. Par défaut, les plans d'utilisation activent un quota pour une période donnée. Pour Demandes, entrez le nombre total de demandes qu'un utilisateur peut effectuer au cours de la période de votre plan d'utilisation. Choisissez Quota pour désactiver le quota.

7. Choisissez Créer un plan d'utilisation.

Pour ajouter une étape au plan d'utilisation

1. Sélectionnez votre plan d'utilisation.

2. Sous l'onglet Étapes associées, choisissez Ajouter une étape.

   

3. Pour API, sélectionnez une API.

4. Pour Étape, sélectionnez une étape.

5. (Facultatif) Pour activer la limitation au niveau de la méthode, procédez comme suit :

   1. Choisissez Limitation au niveau de la méthode, puis choisissez Ajouter une méthode.

   2. Pour Ressource, sélectionnez une ressource dans votre API.

   3. Pour Méthode, sélectionnez une méthode dans votre API.

   4. Entrez un Taux et un Débit pour votre plan d'utilisation.

6. Choisissez Ajouter au plan d'utilisation.

Pour ajouter une clé au plan d'utilisation

1. Sous l'onglet Clés d'API associées, choisissez Ajouter une clé d'API.

   

2. 1. Pour associer une clé existante à votre plan d'utilisation, sélectionnez Ajouter une clé existante, puis sélectionnez votre clé existante dans le menu déroulant.

   2. Pour créer une nouvelle clé d'API, sélectionnez Créer et ajouter une clé, puis créez une nouvelle clé. Pour plus d'informations sur la création d'une nouvelle clé, consultez Créez une clé API :.

3. Choisissez Ajouter une clé d'API.

Test d'un plan d'utilisation

Pour tester le plan d'utilisation, vous pouvez utiliser un AWS SDK ou un client d'API REST tel que Postman. AWS CLI Pour accéder à un exemple d'utilisation de Postman afin de tester le plan d'utilisation, veuillez consulter Test des plans d'utilisation.

Gérer un plan d'utilisation

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.

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

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

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