Comment faire pour configurer la journalisation des accès pour API Gateway ?

Brève description

Pour résoudre les problèmes liés à l’exécution des requêtes ou à l’accès des clients à votre API, vous pouvez activer Amazon CloudWatch Logs pour enregistrer les appels d’API.

Résolution

Pour activer la journalisation des accès pour une API REST, procédez comme suit :

1. Déployez votre API REST jusqu’à une étape.
2. Accordez à API Gateway l’autorisation de lire et d’écrire les journaux de votre compte dans CloudWatch.
3. Suivez les étapes 1 à 6 et 8 à 9 (ignorez l’étape 7) des instructions de la section Configurer la journalisation de l’API CloudWatch à l’aide de la console API Gateway.

Pour activer la journalisation des accès pour une API HTTP, consultez Configurer la journalisation des API HTTP dans API Gateway.

Vous pouvez désormais utiliser vos journaux CloudWatch pour résoudre les problèmes d’API. Par exemple, pour détecter les erreurs liées à une API REST, consultez Comment faire pour détecter les erreurs d’API REST d’API Gateway dans mes journaux CloudWatch ?

Pour plus d’informations sur la surveillance des API REST, consultez Surveiller l’exécution d’API REST à l’aide des métriques Amazon CloudWatch.

Pour plus d’informations sur la surveillance des API HTTP, consultez Surveiller les métriques CloudWatch pour les API HTTP dans API Gateway.

Informations connexes

Comment puis-je résoudre les erreurs « API Gateway » provenant des API REST d’API Gateway ?

Comment faire pour détecter les erreurs 5xx provenant d’API Gateway dans mes journaux CloudWatch ?

Comment faire pour activer les journaux CloudWatch afin de résoudre les problèmes liés à mon API REST d’API Gateway ou à mon API WebSocket ?