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.
Configuration de la CloudWatch journalisation pour les API REST dans API Gateway
Pour vous aider à résoudre les problèmes liés à l'exécution des requêtes ou à l'accès des clients à votre API, vous pouvez autoriser Amazon CloudWatch Logs à enregistrer les appels d'API. Pour plus d'informations sur CloudWatch, consultezSurveillez l'exécution de l'API REST avec CloudWatch les métriques Amazon.
Il existe deux types de connexion à l'API CloudWatch :
-
Journalisation des exécutions : API Gateway enregistre les actions entreprises pour traiter les demandes d'API, y compris les erreurs et les traces d'exécution. Vous pouvez également configurer la diffusion d'Amazon CloudWatch Logs pour acheminer les journaux d'exécution vers vos propres destinations.
-
Enregistrement des accès : vous enregistrez qui a accédé à votre API et comment. Vous créez votre propre groupe de journaux, vous choisissez un format de journal et vous spécifiez les
$contextvariables à inclure.
Vous pouvez activer la journalisation de l’exécution et la journalisation de l’accès indépendamment l’une de l’autre.
Autorisations pour la CloudWatch journalisation
Pour activer CloudWatch les journaux, vous devez autoriser API Gateway à lire et à écrire les journaux CloudWatch de votre compte. La politique AmazonAPIGatewayPushToCloudWatchLogs gérée possède toutes les autorisations requises.
Note
API Gateway lance des appels AWS Security Token Service afin d'assumer le rôle IAM. Assurez-vous donc que cette option AWS STS est activée pour la région. Pour plus d'informations, consultez la section Gestion AWS des STS dans une AWS région.
Pour accorder ces autorisations à votre compte, créez un rôle IAM avec apigateway.amazonaws.com comme entité de confiance, associez la politique précédente au rôle IAM et définissez l'ARN du rôle IAM sur la WatchRoleArn propriété cloud de votre compte. https://docs.aws.amazon.com/apigateway/latest/api/API_GetAccount.html Vous devez définir la WatchRoleArn propriété cloud séparément pour chaque AWS région dans laquelle vous souhaitez activer CloudWatch les journaux.
Si vous recevez un message d'erreur lors de la définition de l'ARN du rôle IAM, vérifiez les paramètres de votre AWS Security Token Service compte pour vous assurer qu' AWS STS il est activé dans la région que vous utilisez. Pour plus d'informations sur l'activation AWS STS, consultez la section Gestion des AWS STS dans une AWS région dans le Guide de l'utilisateur IAM.
