Comment puis-je identifier l'utilisation associée à une clé d'API pour API Gateway ?

Solution

Suivez ces instructions pour obtenir l'utilisation de la clé d'API à l'aide de la Console de gestion AWS ou de l'interface de la ligne de commande AWS (AWS CLI).

Remarque : si vous recevez des erreurs lors de l'exécution de commandes AWS CLI, vérifiez que vous utilisez la version la plus récente d'AWS CLI.

Utiliser la Console de gestion AWS

1. Ouvrez la console API Gateway.
2. Dans le volet de navigation, sélectionnez APIs (API).
3. Choisissez votre API, puis choisissez Usage Plans (Plans d'utilisation).
4. Choisissez votre plan d'utilisation.
5. Choisissez Actions, puis Export Usage Data (Exporter les données d'utilisation).
6. Choisissez la plage de dates From (De) et To (À).
7. Pour Export as (Exporter en tant que), choisissez JSON ou CSV, puisExport (Exporter).

Pour plus d'informations, veuillez consulter la rubrique Création, configuration et test des plans d'utilisation avec la console API Gateway.

Utiliser l'interface de ligne de commande AWS (AWS CLI)

Vous pouvez utiliser la commande de l'AWS CLI get-usage pour obtenir les données d'utilisation d'un plan d'utilisation dans une plage de dates similaire à la suivante :

aws apigateway get-usage --usage-plan-id <usage-plan-id> --start-date "20xx-xx-xx" --end-date "20xx-xx-xx" --key-id <api-key-id>

Remarque : la plage de dates d'utilisation ne peut pas dépasser 90 jours.

Pour plus d'informations, veuillez consulter la rubrique Création, configuration et test des plans d'utilisation avec l'interface de ligne de commande API Gateway et l'API REST.

Informations connexes

Bonnes pratiques pour les clés d'API et les plans d'utilisation