Point de terminaison des métadonnées de tâches Amazon ECS version 4 - Amazon Elastic Container Service
Chemins des points de terminaison des métadonnées de tâches version 4

Point de terminaison des métadonnées de tâches Amazon ECS version 4

L'agent de conteneur Amazon ECS injecte une variable d'environnement dans chaque conteneur, appelée point de terminaison des métadonnées de tâches, qui fournit diverses métadonnées de tâches et statistiques Docker au conteneur.

Les métadonnées de tâche et les statistiques de débit du réseau sont envoyées à CloudWatch Container Insights et peuvent être consultées dans la the console. Pour de plus amples informations, consultez Surveillance des conteneurs Amazon ECS au moyen de Container Insights avec observabilité améliorée.

Note

Amazon ECS fournit des versions antérieures du point de terminaison des métadonnées de tâches. Pour éviter de créer d'autres versions de point de terminaison de métadonnées de tâche à l'avenir, des métadonnées supplémentaires peuvent être ajoutées à la sortie de la version 4. Nous ne supprimons pas les métadonnées existantes et ne modifions pas les noms des champs de métadonnées.

La variable d'environnement est injectée par défaut dans les conteneurs des tâches Amazon ECS lancées sur les instances Linux Amazon EC2 exécutant au moins la version 1.39.0 de l'agent de conteneur Amazon ECS. Pour les instances Windows Amazon EC2 qui utilisent le mode réseau awsvpc, la version de l'agent de conteneur Amazon ECS doit être au moins 1.54.0. Pour de plus amples informations, consultez Gestion des instances de conteneur Amazon ECS Linux.

Note

Vous pouvez ajouter la prise en charge de cette fonctionnalité sur les instances Amazon EC2 utilisant des versions plus anciennes de l'agent de conteneur Amazon ECS en mettant à jour l'agent à la dernière version. Pour de plus amples informations, consultez Mise à jour de l'agent de conteneur Amazon ECS.

Pour des exemples de sortie de métadonnées de tâches, consultez la section Exemples de métadonnées de tâches Amazon ECS v4.

Chemins des points de terminaison des métadonnées de tâches version 4

Les chemins des points de terminaison des métadonnées de tâches suivants sont disponibles pour les conteneurs :

${ECS_CONTAINER_METADATA_URI_V4}

Ce chemin renvoie des métadonnées pour le conteneur.

${ECS_CONTAINER_METADATA_URI_V4}/task

Ce chemin renvoie les métadonnées pour la tâche, y compris une liste des ID et noms de conteneur pour tous les conteneurs associés à la tâche. Pour plus d'informations sur la réponse pour ce point de terminaison, consultez Réponse JSON des métadonnées de tâches Amazon ECS v4.

${ECS_CONTAINER_METADATA_URI_V4}/taskWithTags

Ce chemin renvoie les métadonnées de la tâche incluse dans le point de terminaison /task en plus des balises de tâche et d'instance de conteneur qui peuvent être récupérées à l'aide de l'API ListTagsForResource. Toutes les erreurs reçues lors de la récupération des métadonnées de balise seront incluses dans le champ Errors de la réponse.

Note

Le champ Errors est uniquement dans la réponse pour les tâches hébergées sur des instances Linux Amazon EC2 exécutant au moins la version 1.50.0 de l'agent de conteneur. Pour les instances Windows Amazon EC2 qui utilisent le mode réseau awsvpc, la version de l'agent de conteneur Amazon ECS doit être au moins 1.54.0.

Ce point de terminaison nécessite l'autorisation ecs.ListTagsForResource.

Important

Lorsque vous utilisez le point de terminaison ${ECS_CONTAINER_METADATA_URI_V4}/taskWithTags, sachez que chaque appel génère jusqu’à deux requêtes d’API ecs:ListTagsForResource (une pour les balises d’instance de conteneur et une pour les balises de tâche) et que tous les conteneurs sidecar de la tâche peuvent effectuer ces appels en votre nom. Les appels fréquents aux points de terminaison peuvent entraîner une limitation de l’API.

Envisagez de mettre en œuvre des stratégies de mise en cache ou de traitement par lots pour réduire la fréquence des appels, en particulier dans les applications à fort trafic, et de résoudre les problèmes de limitation des API en utilisant AWS CloudTrail. Pour plus d’informations sur les seuils de limitation de l’API ListTagsForResource, consultez la section Limitation des demandes pour l’API Amazon ECS dans la Référence API Amazon Elastic Container Service. Pour plus d’informations sur le débogage des appels API Amazon ECS à l’aide d’AWS CloudTrail, consultez la section Journalisation des appels à l’API Amazon ECS à l’aide d’AWS CloudTrail.

${ECS_CONTAINER_METADATA_URI_V4}/stats

Ce chemin renvoie les statistiques Docker pour ce conteneur spécifique. Pour plus d'informations sur toutes les statistiques renvoyées, consultez ContainerStats dans la documentation de l'API Docker.

Pour les tâches Amazon ECS qui utilisent les modes réseau awsvpc ou bridge hébergés sur des instances Linux Amazon EC2 exécutant au moins la version 1.43.0 de l'agent de conteneur, il y aura des statistiques de débit réseau supplémentaires incluses dans la réponse. Pour toutes les autres tâches, la réponse inclura uniquement les statistiques cumulatives du réseau.

${ECS_CONTAINER_METADATA_URI_V4}/task/stats

Ce chemin renvoie les statistiques Docker pour tous les conteneurs associés à la tâche. Il peut être utilisé par les conteneurs sidecar pour extraire les métriques réseau. Pour plus d'informations sur toutes les statistiques renvoyées, consultez ContainerStats dans la documentation de l'API Docker.

Pour les tâches Amazon ECS qui utilisent les modes réseau awsvpc ou bridge hébergés sur des instances Linux Amazon EC2 exécutant au moins la version 1.43.0 de l'agent de conteneur, il y aura des statistiques de débit réseau supplémentaires incluses dans la réponse. Pour toutes les autres tâches, la réponse inclura uniquement les statistiques cumulatives du réseau.