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.
Les métriques et dimensions envoyées par API Gateway à Amazon CloudWatch sont répertoriées ci-dessous. Pour plus d’informations, consultez Surveillez l'exécution de l'API REST avec CloudWatch les métriques Amazon.
Métriques API Gateway
Amazon API Gateway envoie les données des métriques à CloudWatch toutes les minutes.
L’espace de noms AWS/ApiGateway
inclut les métriques suivantes.
Métrique | Description |
---|---|
4XXError |
Nombre d’erreurs côté client capturées dans une période donnée. API Gateway considère les codes de statut modifiés des réponses de passerelle comme des erreurs 4XXError. La statistique Unit: Count |
5XXError |
Nombre d’erreurs côté serveur capturées dans une période donnée. La statistique Unit: Count |
CacheHitCount |
Le nombre de demandes servies depuis le cache de l’API sur une période donnée. La statistique Unit: Count |
CacheMissCount |
Nombre de demandes traitées à partir du backend sur une période donnée lorsque la mise en cache des API est activée. La statistique Unit: Count |
Count |
Nombre total de demandes d’API sur une période donnée. La statistique Unit: Count |
IntegrationLatency |
Délai entre le moment de la transmission de la demande au backend par API Gateway et celui de la réception de la réponse du backend. Unit: Millisecond |
Latency |
Délai entre le moment de la réception par API Gateway d’une demande d’un client et celui du renvoi de la réponse au client. La latence prend en compte la latence d’intégration et autres surcharges d’API Gateway. Unit: Millisecond |
Dimensions pour les métriques
Vous pouvez utiliser les dimensions du tableau suivant pour filtrer les métriques API Gateway.
Note
API Gateway supprime les caractères non-ASCII de la dimension ApiName avant d’envoyer les métriques à CloudWatch. Si l’APIName ne contient aucun caractère ASCII, l’API ID est utilisé comme ApiName.
Dimension | Description |
---|---|
ApiName |
Filtre les métriques API Gateway à la recherche de l’API REST avec le nom d’API spécifié. |
ApiName, Method, Resource, Stage |
Filtre les métriques API Gateway à la recherche de la méthode d’API avec le nom d’API, l’étape, la ressource et la méthode spécifiés. API Gateway n’envoie pas ces métriques à moins que vous n’ayez explicitement activé les métriques CloudWatch détaillées. Dans la console, choisissez une étape, puis pour Journaux et suivi, sélectionnez Modifier. Sélectionnez Métriques détaillées, puis cliquez sur Enregistrer les modifications. Sinon, vous pouvez appeler la commande update-stage de l’AWS CLI pour mettre à jour la propriété L’activation de ces métriques implique des frais supplémentaires pour votre compte. Pour plus d’informations, consultez Tarification Amazon CloudWatch |
ApiName, Stage |
Filtre les métriques API Gateway pour trouver la ressource d’étape d’API avec le nom d’API et l’étape spécifiés. |