Activation des métadonnées de tâche Chemins de points de terminaison des métadonnées de tâches Réponse JSON des métadonnées de tâche Exemple de réponse de métadonnées de tâches

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

Important

Le point de terminaison des métadonnées de tâches version 2 n'est plus activement maintenu. Nous vous recommandons de mettre à jour le point de terminaison des métadonnées de tâches version 4 afin d'obtenir les dernières informations relatives au point de terminaison des métadonnées. Pour de plus amples informations, veuillez consulter Point de terminaison des métadonnées des tâches Amazon ECS, version 4.

À partir de la version 1.17.0 de l'agent de conteneur Amazon ECS, différentes métadonnées de tâche et statistiques Docker sont disponibles pour les tâches qui utilisent le mode réseau awsvpc à un point de terminaison HTTP fourni par l'agent de conteneur Amazon ECS.

Tous les conteneurs appartenant à des tâches lancées en mode awsvpc réseau reçoivent une IPv4 adresse locale comprise dans une plage d'adresses lien-local prédéfinie. Lorsqu'un conteneur interroge le point de terminaison des métadonnées, l'agent de conteneur Amazon ECS peut déterminer à quelles tâches le conteneur appartient en fonction de son adresse IP unique. Des métadonnées et des statistiques pour cette tâche sont alors renvoyées.

Activation des métadonnées de tâche

La fonctionnalité des métadonnées de tâches version 2 est activée par défaut pour les éléments suivants :

Les tâches utilisant le type de lancement Fargate et la version de plateforme v1.1.0 ou version ultérieure. Pour de plus amples informations, veuillez consulter Versions de la plateforme Fargate pour Amazon ECS.
Tâches utilisant le type de EC2 lancement qui utilisent également le mode awsvpc réseau et sont lancées sur une infrastructure Amazon EC2 Linux exécutant au moins la version 1.17.0 de l'agent de conteneur Amazon ECS ou sur une infrastructure Amazon EC2 Windows exécutant au moins une version 1.54.0 de l'agent de conteneur Amazon ECS. Pour de plus amples informations, veuillez consulter Gestion des instances de conteneurs Linux Amazon ECS.

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

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

Les points de terminaison d'API suivants sont disponibles pour les conteneurs :

169.254.170.2/v2/metadata: Ce point de terminaison renvoie des métadonnées JSON pour la tâche, y compris une liste des conteneurs IDs et les noms de 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âche.
169.254.170.2/v2/metadata/<container-id>: Ce point de terminaison renvoie le JSON des métadonnées pour l'ID de conteneur Docker spécifié.
169.254.170.2/v2/metadata/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.
169.254.170.2/v2/stats: Ce point de terminaison renvoie le JSON des statistiques Docker pour tous les conteneurs associés à la tâche. Pour plus d'informations sur chacune des statistiques renvoyées, consultez la documentation ContainerStatsde l'API Docker.
169.254.170.2/v2/stats/<container-id>: Ce point de terminaison renvoie le JSON des statistiques Docker pour l'ID de conteneur Docker spécifié. Pour plus d'informations sur chacune des statistiques renvoyées, consultez la documentation ContainerStatsde l'API Docker.

Réponse JSON des métadonnées de tâche

Les informations suivantes sont renvoyées à partir de la réponse JSON du point de terminaison de métadonnées de la tâche (169.254.170.2/v2/metadata).

Cluster

Amazon Resource Name (ARN) ou nom abrégé du cluster Amazon ECS auquel la tâche appartient.

TaskARN

Le nom de ressource Amazon (ARN) de la tâche à laquelle appartient le conteneur.

Family

Famille de la définition de tâche Amazon ECS pour la tâche.

Revision

Révision de la définition de tâche Amazon ECS pour la tâche.

DesiredStatus

État souhaité pour la tâche à partir d'Amazon ECS.

KnownStatus

État connu pour la tâche à partir d'Amazon ECS.

Limits

Les limites de ressources spécifiées au niveau de la tâche, telles que le processeur (exprimé en vCPUs) et la mémoire. Ce paramètre n'est pas spécifié si aucune limite de ressource n'a été définie.

PullStartedAt

Horodatage au moment où la première extraction de l'image de conteneur a commencé.

PullStoppedAt

Horodatage au moment où la dernière extraction de l'image de conteneur s'est terminée.

AvailabilityZone

Zone de disponibilité dans laquelle se trouve la tâche.

Note

Les métadonnées de la zone de disponibilité sont uniquement disponibles pour les tâches Fargate qui utilisent la version 1.4 de la plateforme ou ultérieure (Linux) ou la version 1.0.0 de la plateforme ou ultérieure (Windows).

Containers

Liste de métadonnées de conteneur pour chaque conteneur associé à la tâche.

DockerId: ID Docker du conteneur.
Name: Nom du conteneur tel que spécifié dans la définition de tâche.
DockerName: Nom du conteneur fourni à Docker. L'agent de conteneur Amazon ECS génère un nom unique pour le conteneur afin d'éviter les conflits de noms lorsque plusieurs copies de la même définition de tâche sont exécutées sur une seule instance.
Image: Image à utiliser pour le conteneur.
ImageID: Le condensé SHA-256 du manifeste d'image. Il s'agit du condensé qui peut être utilisé pour extraire l'image en utilisant le formatrepository-url/image@sha256:digest.
Ports: Tous les ports exposés pour le conteneur. Ce paramètre n'est pas spécifié s'il n'y a pas de ports exposés.
Labels: Toutes les étiquettes appliquées au conteneur. Ce paramètre n'est pas spécifié si aucune étiquette n'est appliquée.
DesiredStatus: État souhaité pour le conteneur à partir d'Amazon ECS.
KnownStatus: État connu pour le conteneur à partir d'Amazon ECS.
ExitCode: Code de sortie pour le conteneur. Ce paramètre n'est pas spécifié si le conteneur n'est pas sorti.
Limits: Limites de ressource spécifiées au niveau du conteneur, par exemple, le processeur (exprimé en unités de processeur) et la mémoire. Ce paramètre n'est pas spécifié si aucune limite de ressource n'a été définie.
CreatedAt: Horodatage de création du conteneur. Ce paramètre n'est pas spécifié si le conteneur n'a pas encore été créé.
StartedAt: Horodatage de démarrage du conteneur. Ce paramètre n'est pas spécifié si le conteneur n'a pas encore été démarré.
FinishedAt: Horodatage d'arrêt du conteneur. Ce paramètre n'est pas spécifié si le conteneur n'a pas encore été arrêté.
Type: Type du conteneur. Les conteneurs qui sont spécifiés dans votre définition de tâche sont de type NORMAL. Vous pouvez ignorer les autres types de conteneurs, qui sont utilisés pour l'approvisionnement des ressources de tâches internes par l'agent de conteneur Amazon ECS.
Networks: Informations de réseau du conteneur, par exemple le mode réseau et l'adresse IP. Ce paramètre n'est pas spécifié si aucune information de réseau n'est définie.

ClockDrift

Informations sur la différence entre l'heure de référence et l'heure du système. Cela s'applique au système d'exploitation Linux. Cette fonctionnalité utilise Amazon Time Sync Service pour mesurer la précision de l'horloge et fournir l'erreur d'horloge liée aux conteneurs. Pour plus d'informations, consultez Définir l'heure pour votre instance Linux dans le Guide de EC2 l'utilisateur Amazon pour les instances Linux.

ReferenceTime

La base de la précision de l'horloge. Amazon ECS utilise la norme mondiale du temps universel coordonné (UTC) via NTP, par exemple 2021-09-07T16:57:44Z.

ClockErrorBound

La mesure de l'erreur de l'horloge est exprimée par le décalage par rapport à l'UTC. Cette erreur correspond à la différence en millisecondes entre l'heure de référence et l'heure du système.

ClockSynchronizationStatus

Indique si la tentative de synchronisation la plus récente entre l'heure système et l'heure de référence a réussi.

Les valeurs valides sont SYNCHRONIZED et NOT_SYNCHRONIZED.

ExecutionStoppedAt

Horodatage au moment où l'état des tâches est passé de DesiredStatus à STOPPED. Cela se produit lorsqu'un conteneur essentiel passe à STOPPED.

Exemple de réponse de métadonnées de tâches

La réponse JSON suivante est pour une tâche comportant un seul conteneur.


{
  "Cluster": "default",
  "TaskARN": "arn:aws:ecs:us-east-2:012345678910:task/9781c248-0edd-4cdb-9a93-f63cb662a5d3",
  "Family": "nginx",
  "Revision": "5",
  "DesiredStatus": "RUNNING",
  "KnownStatus": "RUNNING",
  "Containers": [
    {
      "DockerId": "731a0d6a3b4210e2448339bc7015aaa79bfe4fa256384f4102db86ef94cbbc4c",
      "Name": "~internal~ecs~pause",
      "DockerName": "ecs-nginx-5-internalecspause-acc699c0cbf2d6d11700",
      "Image": "amazon/amazon-ecs-pause:0.1.0",
      "ImageID": "",
      "Labels": {
        "com.amazonaws.ecs.cluster": "default",
        "com.amazonaws.ecs.container-name": "~internal~ecs~pause",
        "com.amazonaws.ecs.task-arn": "arn:aws:ecs:us-east-2:012345678910:task/9781c248-0edd-4cdb-9a93-f63cb662a5d3",
        "com.amazonaws.ecs.task-definition-family": "nginx",
        "com.amazonaws.ecs.task-definition-version": "5"
      },
      "DesiredStatus": "RESOURCES_PROVISIONED",
      "KnownStatus": "RESOURCES_PROVISIONED",
      "Limits": {
        "CPU": 0,
        "Memory": 0
      },
      "CreatedAt": "2018-02-01T20:55:08.366329616Z",
      "StartedAt": "2018-02-01T20:55:09.058354915Z",
      "Type": "CNI_PAUSE",
      "Networks": [
        {
          "NetworkMode": "awsvpc",
          "IPv4Addresses": [
            "10.0.2.106"
          ]
        }
      ]
    },
    {
      "DockerId": "43481a6ce4842eec8fe72fc28500c6b52edcc0917f105b83379f88cac1ff3946",
      "Name": "nginx-curl",
      "DockerName": "ecs-nginx-5-nginx-curl-ccccb9f49db0dfe0d901",
      "Image": "nrdlngr/nginx-curl",
      "ImageID": "sha256:2e00ae64383cfc865ba0a2ba37f61b50a120d2d9378559dcd458dc0de47bc165",
      "Labels": {
        "com.amazonaws.ecs.cluster": "default",
        "com.amazonaws.ecs.container-name": "nginx-curl",
        "com.amazonaws.ecs.task-arn": "arn:aws:ecs:us-east-2:012345678910:task/9781c248-0edd-4cdb-9a93-f63cb662a5d3",
        "com.amazonaws.ecs.task-definition-family": "nginx",
        "com.amazonaws.ecs.task-definition-version": "5"
      },
      "DesiredStatus": "RUNNING",
      "KnownStatus": "RUNNING",
      "Limits": {
        "CPU": 512,
        "Memory": 512
      },
      "CreatedAt": "2018-02-01T20:55:10.554941919Z",
      "StartedAt": "2018-02-01T20:55:11.064236631Z",
      "Type": "NORMAL",
      "Networks": [
        {
          "NetworkMode": "awsvpc",
          "IPv4Addresses": [
            "10.0.2.106"
          ]
        }
      ]
    }
  ],
  "PullStartedAt": "2018-02-01T20:55:09.372495529Z",
  "PullStoppedAt": "2018-02-01T20:55:10.552018345Z",
  "AvailabilityZone": "us-east-2b"
}

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Exemples de métadonnées de tâches v3

Métadonnées de tâches disponibles pour les tâches sur Fargate