Point de terminaison des métadonnées des 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 des tâches et les statistiques du débit du réseau sont envoyées à CloudWatch Container Insights et peuvent être consultées dans le AWS Management Console. Pour plus d’informations, consultez Surveillez les conteneurs Amazon ECS à l'aide de Container Insights.

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 plus d’informations, consultez Gestion des instances de conteneur 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 plus d’informations, consultez Mise à jour de l'agent de conteneur Amazon ECS.

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 V4 aux métadonnées des tâches Amazon ECS.

${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.

${ECS_CONTAINER_METADATA_URI_V4}/stats

Ce chemin renvoie les statistiques Docker pour ce conteneur spécifique. Pour plus d'informations sur chacune des statistiques renvoyées, consultez la documentation ContainerStatsde 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 chacune des statistiques renvoyées, consultez la documentation ContainerStatsde 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.