# Versión 4 del punto de conexión de los metadatos de tareas de Amazon ECS para tareas en Fargate
**importante**
Si utiliza tareas de Amazon ECS alojadas en instancias de Amazon EC2, consulte [Amazon ECS task metadata endpoint](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint.html).
A partir de la versión `1.4.0` de la plataforma de Fargate, se ha incluido una variable de entorno con el nombre `ECS_CONTAINER_METADATA_URI_V4` en cada contenedor de una tarea. Cuando consulta la versión 4 del punto de enlace de metadatos de tareas, hay diversos metadatos y [estadísticas de Docker](https://docs.docker.com/engine/api/v1.30/#operation/ContainerStats) disponibles para las tareas.
La versión 4 del punto de enlace de metadatos de tareas funciona como la versión 3, pero proporciona metadatos de red adicionales para los contenedores y las tareas. También hay otras métricas de red que están disponibles al consultar los puntos de enlace `/stats`.
El punto de conexión de metadatos de tareas está habilitado de forma predeterminada para todas las tareas de Amazon ECS que se ejecutan en AWS Fargate y utilizan la versión de la plataforma `1.4.0` o una posterior.
**nota**
Para no tener que crear nuevas versiones de los puntos de enlace de metadatos de tareas en el futuro, se pueden agregar otros metadatos a la salida de la versión 4. No vamos a eliminar ningún metadato existente ni a modificar los nombres de los campos de metadatos.
## Rutas de la versión 4 del punto de conexión de metadatos de tareas de Fargate
Los siguientes puntos de enlace de metadatos de tarea están disponibles para los contenedores:
`${ECS_CONTAINER_METADATA_URI_V4}`
Esta ruta devuelve metadatos del contenedor.
`${ECS_CONTAINER_METADATA_URI_V4}/task`
Esta ruta devuelve metadatos de la tarea, incluso una lista de los nombres e ID de contenedor de todos los contenedores asociados a la tarea. Para obtener más información sobre la respuesta de este punto de enlace, consulte [Respuesta JSON para la versión 4 de los metadatos de tareas de Amazon ECS para tareas en Fargate](task-metadata-endpoint-v4-fargate-response.md).
`${ECS_CONTAINER_METADATA_URI_V4}/stats`
Esta ruta devuelve estadísticas de Docker del contenedor de Docker. Para obtener más información acerca de cada una de las estadísticas devueltas, consulte [ContainerStats](https://docs.docker.com/engine/api/v1.30/#operation/ContainerStats) en la documentación del API de Docker.
Las tareas de Amazon ECS alojadas en AWS Fargate requieren que el contenedor se ejecute durante \$11 segundo antes de devolver las estadísticas del contenedor.
`${ECS_CONTAINER_METADATA_URI_V4}/task/stats`
Esta ruta devuelve estadísticas de Docker de todos los contenedores asociados a la tarea. Para obtener más información acerca de cada una de las estadísticas devueltas, consulte [ContainerStats](https://docs.docker.com/engine/api/v1.30/#operation/ContainerStats) en la documentación del API de Docker.
Las tareas de Amazon ECS alojadas en AWS Fargate requieren que el contenedor se ejecute durante \$11 segundo antes de devolver las estadísticas del contenedor.
# Respuesta JSON para la versión 4 de los metadatos de tareas de Amazon ECS para tareas en Fargate
La respuesta JSON de punto de enlace de metadatos de tareas (`${ECS_CONTAINER_METADATA_URI_V4}/task`) devuelve los siguientes metadatos.
`Cluster`
El nombre de recurso de Amazon (ARN) o el nombre corto del clúster de Amazon ECS al que pertenece la tarea.
`ServiceName`
El nombre del servicio al que pertenece la tarea. ServiceName aparecerá para las tareas de Fargate asociadas a un servicio.
`VPCID`
El ID de VPC de la instancia de contenedor de Amazon EC2. Este campo solo aparece para las instancias de Amazon EC2.
Los metadatos de `VPCID` solo se incluyen cuando se utiliza la versión `1.63.1` o una posterior del agente de contenedores de Amazon ECS.
`TaskARN`
Nombre de recurso de Amazon (ARN) de la tarea al que pertenece el contenedor.
`Family`
La familia de la definición de tareas de Amazon ECS para la tarea.
`Revision`
La revisión de la definición de tareas de Amazon ECS para la tarea.
`DesiredStatus`
El estado deseado para la tarea de Amazon ECS.
`KnownStatus`
El estado conocido para la tarea de Amazon ECS.
`Limits`
Los límites de recursos especificados en niveles de tarea, por ejemplo, CPU (expresado en vCPU) y memoria. Este parámetro se omite si no se definen límites de recurso.
`PullStartedAt`
La marca temporal del momento en que comenzó la primera extracción de la imagen del contenedor.
`PullStoppedAt`
La marca temporal del momento en que finalizó la última extracción de la imagen del contenedor.
`AvailabilityZone`
La zona de disponibilidad donde está la tarea.
Los metadatos de la zona de disponibilidad solo están disponibles para las tareas de Fargate que utilicen la versión 1.4 o posterior (Linux) o 1.0.0 (Windows) de la plataforma.
`LaunchType`
El tipo de lanzamiento que usa la tarea. Cuando se utilizan proveedores de capacidad de clúster, indica si la tarea está utilizando la infraestructura Fargate o EC2.
Este metadato `LaunchType` solo se incluye cuando se utiliza la versión `1.45.0` o posterior (Linux) o 1.0.0 o posterior (Windows) del agente de contenedor de Amazon ECS o una posterior.
`EphemeralStorageMetrics`
El tamaño reservado y el uso actual del almacenamiento efímero de esta tarea.
Fargate reserva espacio en el disco. Solo lo usa Fargate. No se cobra por esto. No se muestra en estas métricas. Sin embargo, puede ver este almacenamiento adicional en otras herramientas, como `df`.
`Utilized`
El uso actual del almacenamiento efímero (en MiB) de esta tarea.
`Reserved`
El almacenamiento efímero reservado (en MiB) de esta tarea. El tamaño de almacenamiento efímero no se puede cambiar en una tarea en ejecución. Puede especificar el objeto `ephermalStorage` en la definición de tarea para cambiar la cantidad de almacenamiento efímero. `ephermalStorage` se especifica en GiB, no en MiB. `ephermalStorage` y `EphemeralStorageMetrics` solo están disponibles en la versión 1.4.0 o posterior de la plataforma Fargate de Linux.
`Containers`
Una lista de metadatos de contenedor para cada contenedor asociado con la tarea.
`DockerId`
El ID de Docker para el contenedor.
Cuando usa Fargate, el ID es un hexadecimal de 32 dígitos seguido de un número de 10 dígitos.
`Name`
El nombre del contenedor tal y como se especifica en la definición de tarea.
`DockerName`
El nombre del contenedor suministrado a Docker. El agente de contenedor de Amazon ECS genera un nombre único para el contenedor a fin de evitar conflictos de nombre cuando se ejecutan en una sola instancia varias copias de la misma definición de tareas.
`Image`
La imagen para el contenedor.
`ImageID`
El resumen SHA-256 del manifiesto de la imagen. Este es el resumen que se puede usar para extraer la imagen utilizando el formato `repository-url/image@sha256:digest`.
`Ports`
Los puertos expuestos para el contenedor. Este parámetro se omite si no hay puertos expuestos.
`Labels`
Cualquier etiqueta aplicada al contenedor. Este parámetro se omite si no hay etiquetas aplicadas.
`DesiredStatus`
El estado deseado para el contenedor procedente de Amazon ECS.
`KnownStatus`
El estado conocido para el contenedor procedente de Amazon ECS.
`ExitCode`
El código de salida para el contenedor. Este parámetro se omite si el contenedor no ha salido.
`Limits`
Los límites de recursos especificados en el nivel de contenedor, por ejemplo, CPU (expresado en unidades de CPU) y memoria. Este parámetro se omite si no se definen límites de recurso.
`CreatedAt`
La marca de hora para cuando el contenedor se creó. Este parámetro se omite si el contenedor no ha se ha creado aún.
`StartedAt`
La marca de hora para cuando el contenedor se inició. Este parámetro se omite si el contenedor no ha se ha iniciado aún.
`FinishedAt`
La marca de hora para cuando el contenedor se detuvo. Este parámetro se omite si el contenedor no ha se ha detenido aún.
`Type`
El tipo del contenedor. Los contenedores que se especifican en su definición de tarea son de tipo `NORMAL`. Puede hacer caso omiso de otros tipos de contenedores que utiliza el agente de contenedor de Amazon ECS para el aprovisionamiento de recursos para tareas internas.
`LogDriver`
El controlador de registros que utiliza el contenedor.
Este metadato `LogDriver` solo se incluye cuando se utiliza la versión `1.45.0` del agente de contenedor de Linux de Amazon ECS o una posterior.
`LogOptions`
Opciones del controlador de registros definidas para el contenedor.
Este metadato `LogOptions` solo se incluye cuando se utiliza la versión `1.45.0` del agente de contenedor de Linux de Amazon ECS o una posterior.
`ContainerARN`
El nombre de recurso de Amazon (ARN) del contenedor.
Este metadato `ContainerARN` solo se incluye cuando se utiliza la versión `1.45.0` del agente de contenedor de Linux de Amazon ECS o una posterior.
`Networks`
La información de red del contenedor, como la dirección IP y el modo de red. Este parámetro se omite si no se define ninguna información de red.
`Snapshotter`
El snapshotter que utilizó containerd para descargar la imagen de este contenedor. Los valores válidos son `overlayfs`, que es el predeterminado, y `soci` se utilizan cuando se carga en diferido con un índice SOCI. Este parámetro solo está disponible para las tareas que se ejecuten en la versión de la plataforma `1.4.0` de Linux.
`RestartCount`
La cantidad de veces que se reinició el contenedor.
Los metadatos `RestartCount` se incluyen solo si hay una política de reinicio habilitada para el contenedor. Para obtener más información, consulte [Reinicio de contenedores individuales en tareas de Amazon ECS con políticas de reinicio de contenedores](container-restart-policy.md).
`ClockDrift`
La información sobre la diferencia entre la hora de referencia y la hora del sistema. Esta capacidad utiliza el Servicio de sincronización temporal de Amazon para medir la precisión del reloj y proporcionar el límite de error de reloj de los contenedores. Para más información, consulte [Set the time for your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-time.html) en la *Guía del usuario de Amazon EC2 para instancias de Linux*.
`ReferenceTime`
La base de la precisión del reloj. Amazon ECS utiliza el estándar global de hora universal coordinada (UTC) a través de NTP, por ejemplo `2021-09-07T16:57:44Z`.
`ClockErrorBound`
La medida del error de reloj, definida como el desplazamiento a UTC. Este error es la diferencia en milisegundos entre la hora de referencia y la hora del sistema.
`ClockSynchronizationStatus`
Indica si el intento de sincronización más reciente entre la hora del sistema y la hora de referencia se ha realizado correctamente.
Los valores válidos son `SYNCHRONIZED` y ` NOT_SYNCHRONIZED`.
`ExecutionStoppedAt`
La marca temporal para cuando el `DesiredStatus` de la tarea pasó a `STOPPED`. Esto ocurre cuando un contenedor esencial pasa a `STOPPED`.
# Ejemplos de la versión 4 de los metadatos de tareas de Amazon ECS para tareas en Fargate
En los siguientes ejemplos, se muestran resultados de ejemplo de los puntos de enlace de metadatos de tareas para tareas de Amazon ECS que se ejecutan en AWS Fargate.
En el contenedor, puede utilizar curl seguido por el punto de conexión de metadatos de tarea para consultar el punto de conexión, por ejemplo `curl ${ECS_CONTAINER_METADATA_URI_V4}/task`.
## Ejemplo de respuesta de metadatos del contenedor
Cuando se consulta el punto de enlace `${ECS_CONTAINER_METADATA_URI_V4}`, solo se devuelven los metadatos relacionados con el propio contenedor. El siguiente es un ejemplo de salida.
```
{
"DockerId": "cd189a933e5849daa93386466019ab50-2495160603",
"Name": "curl",
"DockerName": "curl",
"Image": "111122223333.dkr.ecr.us-west-2.amazonaws.com/curltest:latest",
"ImageID": "sha256:25f3695bedfb454a50f12d127839a68ad3caf91e451c1da073db34c542c4d2cb",
"Labels": {
"com.amazonaws.ecs.cluster": "arn:aws:ecs:us-west-2:111122223333:cluster/default",
"com.amazonaws.ecs.container-name": "curl",
"com.amazonaws.ecs.task-arn": "arn:aws:ecs:us-west-2:111122223333:task/default/cd189a933e5849daa93386466019ab50",
"com.amazonaws.ecs.task-definition-family": "curltest",
"com.amazonaws.ecs.task-definition-version": "2"
},
"DesiredStatus": "RUNNING",
"KnownStatus": "RUNNING",
"Limits": {
"CPU": 10,
"Memory": 128
},
"CreatedAt": "2020-10-08T20:09:11.44527186Z",
"StartedAt": "2020-10-08T20:09:11.44527186Z",
"Type": "NORMAL",
"Networks": [
{
"NetworkMode": "awsvpc",
"IPv4Addresses": [
"192.0.2.3"
],
"AttachmentIndex": 0,
"MACAddress": "0a:de:f6:10:51:e5",
"IPv4SubnetCIDRBlock": "192.0.2.0/24",
"DomainNameServers": [
"192.0.2.2"
],
"DomainNameSearchList": [
"us-west-2.compute.internal"
],
"PrivateDNSName": "ip-10-0-0-222.us-west-2.compute.internal",
"SubnetGatewayIpv4Address": "192.0.2.0/24"
}
],
"ContainerARN": "arn:aws:ecs:us-west-2:111122223333:container/05966557-f16c-49cb-9352-24b3a0dcd0e1",
"LogOptions": {
"awslogs-create-group": "true",
"awslogs-group": "/ecs/containerlogs",
"awslogs-region": "us-west-2",
"awslogs-stream": "ecs/curl/cd189a933e5849daa93386466019ab50"
},
"LogDriver": "awslogs",
"Snapshotter": "overlayfs"
}
```
## Ejemplos de la versión 4 de los metadatos de tareas de Amazon ECS para tareas en Fargate
Cuando se consulta el punto de enlace `${ECS_CONTAINER_METADATA_URI_V4}/task`, se devuelven los metadatos relacionados con la tarea de la que forma parte el contenedor. El siguiente es un ejemplo de salida.
```
{
"Cluster": "arn:aws:ecs:us-east-1:123456789012:cluster/MyEmptyCluster",
"TaskARN": "arn:aws:ecs:us-east-1:123456789012:task/MyEmptyCluster/bfa2636268144d039771334145e490c5",
"Family": "sample-fargate",
"Revision": "5",
"DesiredStatus": "RUNNING",
"KnownStatus": "RUNNING",
"Limits": {
"CPU": 0.25,
"Memory": 512
},
"PullStartedAt": "2023-07-21T15:45:33.532811081Z",
"PullStoppedAt": "2023-07-21T15:45:38.541068435Z",
"AvailabilityZone": "us-east-1d",
"Containers": [
{
"DockerId": "bfa2636268144d039771334145e490c5-1117626119",
"Name": "curl-image",
"DockerName": "curl-image",
"Image": "curlimages/curl",
"ImageID": "sha256:daf3f46a2639c1613b25e85c9ee4193af8a1d538f92483d67f9a3d7f21721827",
"Labels": {
"com.amazonaws.ecs.cluster": "arn:aws:ecs:us-east-1:123456789012:cluster/MyEmptyCluster",
"com.amazonaws.ecs.container-name": "curl-image",
"com.amazonaws.ecs.task-arn": "arn:aws:ecs:us-east-1:123456789012:task/MyEmptyCluster/bfa2636268144d039771334145e490c5",
"com.amazonaws.ecs.task-definition-family": "sample-fargate",
"com.amazonaws.ecs.task-definition-version": "5"
},
"DesiredStatus": "RUNNING",
"KnownStatus": "RUNNING",
"Limits": { "CPU": 128 },
"CreatedAt": "2023-07-21T15:45:44.91368314Z",
"StartedAt": "2023-07-21T15:45:44.91368314Z",
"Type": "NORMAL",
"Networks": [
{
"NetworkMode": "awsvpc",
"IPv4Addresses": ["172.31.42.189"],
"AttachmentIndex": 0,
"MACAddress": "0e:98:9f:33:76:d3",
"IPv4SubnetCIDRBlock": "172.31.32.0/20",
"DomainNameServers": ["172.31.0.2"],
"DomainNameSearchList": ["ec2.internal"],
"PrivateDNSName": "ip-172-31-42-189.ec2.internal",
"SubnetGatewayIpv4Address": "172.31.32.1/20"
}
],
"ContainerARN": "arn:aws:ecs:us-east-1:123456789012:container/MyEmptyCluster/bfa2636268144d039771334145e490c5/da6cccf7-1178-400c-afdf-7536173ee209",
"Snapshotter": "overlayfs"
},
{
"DockerId": "bfa2636268144d039771334145e490c5-3681984407",
"Name": "fargate-app",
"DockerName": "fargate-app",
"Image": "public.ecr.aws/docker/library/httpd:latest",
"ImageID": "sha256:8059bdd0058510c03ae4c808de8c4fd2c1f3c1b6d9ea75487f1e5caa5ececa02",
"Labels": {
"com.amazonaws.ecs.cluster": "arn:aws:ecs:us-east-1:123456789012:cluster/MyEmptyCluster",
"com.amazonaws.ecs.container-name": "fargate-app",
"com.amazonaws.ecs.task-arn": "arn:aws:ecs:us-east-1:123456789012:task/MyEmptyCluster/bfa2636268144d039771334145e490c5",
"com.amazonaws.ecs.task-definition-family": "sample-fargate",
"com.amazonaws.ecs.task-definition-version": "5"
},
"DesiredStatus": "RUNNING",
"KnownStatus": "RUNNING",
"Limits": { "CPU": 2 },
"CreatedAt": "2023-07-21T15:45:44.954460255Z",
"StartedAt": "2023-07-21T15:45:44.954460255Z",
"Type": "NORMAL",
"Networks": [
{
"NetworkMode": "awsvpc",
"IPv4Addresses": ["172.31.42.189"],
"AttachmentIndex": 0,
"MACAddress": "0e:98:9f:33:76:d3",
"IPv4SubnetCIDRBlock": "172.31.32.0/20",
"DomainNameServers": ["172.31.0.2"],
"DomainNameSearchList": ["ec2.internal"],
"PrivateDNSName": "ip-172-31-42-189.ec2.internal",
"SubnetGatewayIpv4Address": "172.31.32.1/20"
}
],
"ContainerARN": "arn:aws:ecs:us-east-1:123456789012:container/MyEmptyCluster/bfa2636268144d039771334145e490c5/f65b461d-aa09-4acb-a579-9785c0530cbc",
"Snapshotter": "overlayfs"
}
],
"LaunchType": "FARGATE",
"ClockDrift": {
"ClockErrorBound": 0.446931,
"ReferenceTimestamp": "2023-07-21T16:09:17Z",
"ClockSynchronizationStatus": "SYNCHRONIZED"
},
"EphemeralStorageMetrics": {
"Utilized": 261,
"Reserved": 20496
}
}
```
## Ejemplo de respuesta de estadísticas de las tareas
Cuando se consulta el punto de enlace `${ECS_CONTAINER_METADATA_URI_V4}/task/stats`, se devuelven las métricas de red relacionadas con la tarea de la que forma parte el contenedor. El siguiente es un ejemplo de salida.
```
{
"3d1f891cded94dc795608466cce8ddcf-464223573": {
"read": "2020-10-08T21:24:44.938937019Z",
"preread": "2020-10-08T21:24:34.938633969Z",
"pids_stats": {},
"blkio_stats": {
"io_service_bytes_recursive": [
{
"major": 202,
"minor": 26368,
"op": "Read",
"value": 638976
},
{
"major": 202,
"minor": 26368,
"op": "Write",
"value": 0
},
{
"major": 202,
"minor": 26368,
"op": "Sync",
"value": 638976
},
{
"major": 202,
"minor": 26368,
"op": "Async",
"value": 0
},
{
"major": 202,
"minor": 26368,
"op": "Total",
"value": 638976
}
],
"io_serviced_recursive": [
{
"major": 202,
"minor": 26368,
"op": "Read",
"value": 12
},
{
"major": 202,
"minor": 26368,
"op": "Write",
"value": 0
},
{
"major": 202,
"minor": 26368,
"op": "Sync",
"value": 12
},
{
"major": 202,
"minor": 26368,
"op": "Async",
"value": 0
},
{
"major": 202,
"minor": 26368,
"op": "Total",
"value": 12
}
],
"io_queue_recursive": [],
"io_service_time_recursive": [],
"io_wait_time_recursive": [],
"io_merged_recursive": [],
"io_time_recursive": [],
"sectors_recursive": []
},
"num_procs": 0,
"storage_stats": {},
"cpu_stats": {
"cpu_usage": {
"total_usage": 1137691504,
"percpu_usage": [
696479228,
441212276,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"usage_in_kernelmode": 80000000,
"usage_in_usermode": 810000000
},
"system_cpu_usage": 9393210000000,
"online_cpus": 2,
"throttling_data": {
"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
},
"precpu_stats": {
"cpu_usage": {
"total_usage": 1136624601,
"percpu_usage": [
695639662,
440984939,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"usage_in_kernelmode": 80000000,
"usage_in_usermode": 810000000
},
"system_cpu_usage": 9373330000000,
"online_cpus": 2,
"throttling_data": {
"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
},
"memory_stats": {
"usage": 6504448,
"max_usage": 8458240,
"stats": {
"active_anon": 1675264,
"active_file": 557056,
"cache": 651264,
"dirty": 0,
"hierarchical_memory_limit": 536870912,
"hierarchical_memsw_limit": 9223372036854772000,
"inactive_anon": 0,
"inactive_file": 3088384,
"mapped_file": 430080,
"pgfault": 11034,
"pgmajfault": 5,
"pgpgin": 8436,
"pgpgout": 7137,
"rss": 4669440,
"rss_huge": 0,
"total_active_anon": 1675264,
"total_active_file": 557056,
"total_cache": 651264,
"total_dirty": 0,
"total_inactive_anon": 0,
"total_inactive_file": 3088384,
"total_mapped_file": 430080,
"total_pgfault": 11034,
"total_pgmajfault": 5,
"total_pgpgin": 8436,
"total_pgpgout": 7137,
"total_rss": 4669440,
"total_rss_huge": 0,
"total_unevictable": 0,
"total_writeback": 0,
"unevictable": 0,
"writeback": 0
},
"limit": 9223372036854772000
},
"name": "curltest",
"id": "3d1f891cded94dc795608466cce8ddcf-464223573",
"networks": {
"eth1": {
"rx_bytes": 2398415937,
"rx_packets": 1898631,
"rx_errors": 0,
"rx_dropped": 0,
"tx_bytes": 1259037719,
"tx_packets": 428002,
"tx_errors": 0,
"tx_dropped": 0
}
},
"network_rate_stats": {
"rx_bytes_per_sec": 43.298687872232854,
"tx_bytes_per_sec": 215.39347269466413
}
}
}
```