# Endpoint de metadados de tarefas do Amazon ECS versão 4 para tarefas no Fargate **Importante** Se estiver usando tarefas do Amazon ECS hospedadas em instâncias do Amazon EC2, consulte [Amazon ECS task metadata endpoint](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint.html). Começando com a versão `1.4.0` da plataforma do Fargate, uma variável de ambiente denominada `ECS_CONTAINER_METADATA_URI_V4` é injetada em cada contêiner de uma tarefa. Quando você consulta o endpoint de metadados de tarefas versão 4, vários metadados de tarefas e [dados estatísticos do Docker](https://docs.docker.com/engine/api/v1.30/#operation/ContainerStats) estão disponíveis para tarefas. O endpoint de metadados de tarefas versão 4 funciona como o endpoint versão 3, mas fornece metadados de rede adicionais para contêineres e tarefas. Métricas de rede adicionais também estão disponíveis ao consultar os endpoints `/stats`. O endpoint de metadados de tarefa é ativado por padrão para todas as tarefas do Amazon ECS executadas no AWS Fargate que usam a versão `1.4.0` ou posterior da plataforma. **nota** Para evitar a necessidade de criar novas versões de endpoint de metadados de tarefas no futuro, os metadados adicionais podem ser adicionados à saída da versão 4. Não removeremos quaisquer metadados existentes nem alteraremos os nomes dos campos de metadados. ## Caminhos do endpoint de metadados de tarefas do Fargate versão 4 Os seguintes endpoints de metadados de tarefas estão disponíveis para os contêineres: `${ECS_CONTAINER_METADATA_URI_V4}` Esse caminho retorna metadados para o contêiner. `${ECS_CONTAINER_METADATA_URI_V4}/task` Esse caminho retorna metadados para a tarefa, incluindo uma lista dos nomes e IDs de todos os contêineres associados à tarefa. Para obter mais informações sobre a resposta para esse endpoint, consulte [Resposta JSON para metadados de tarefas v4 no Amazon ECS para tarefas no Fargate](task-metadata-endpoint-v4-fargate-response.md). `${ECS_CONTAINER_METADATA_URI_V4}/stats` Esse caminho retorna dados estatísticos do Docker para o contêiner do Docker. Para obter mais informações sobre cada uma das estatísticas retornadas, consulte [ContainerStats](https://docs.docker.com/engine/api/v1.30/#operation/ContainerStats) na documentação da API do Docker. Tarefas do Amazon ECS no AWS Fargate exigem que o contêiner seja executado por \$11 segundo antes de retornar os dados estatísticos do contêiner. `${ECS_CONTAINER_METADATA_URI_V4}/task/stats` Esse caminho retorna os dados estatísticos do Docker para todos os contêineres associados à tarefa. Para obter mais informações sobre cada uma das estatísticas retornadas, consulte [ContainerStats](https://docs.docker.com/engine/api/v1.30/#operation/ContainerStats) na documentação da API do Docker. Tarefas do Amazon ECS no AWS Fargate exigem que o contêiner seja executado por \$11 segundo antes de retornar os dados estatísticos do contêiner. # Resposta JSON para metadados de tarefas v4 no Amazon ECS para tarefas no Fargate Os seguintes metadados são retornados na resposta em formato JSON (`${ECS_CONTAINER_METADATA_URI_V4}/task`) do endpoint de metadados da tarefa. `Cluster` O nome do recurso da Amazon (ARN) ou nome curto do cluster do Amazon ECS ao qual a tarefa pertence. `ServiceName` O nome do serviço ao qual a tarefa pertence. ServiceName será exibido para tarefas do Fargate associadas a um serviço. `VPCID` O ID da VPC da instância de contêiner do Amazon EC2. Esse campo é exibido somente para instâncias do Amazon EC2. Os metadados `VPCID` são incluídos somente quando é usada a versão `1.63.1` ou posterior do agente de contêiner do Amazon ECS. `TaskARN` O nome do recurso da Amazon (ARN) da tarefa à qual o contêiner pertence. `Family` A família da definição de tarefa do Amazon ECS para a tarefa. `Revision` A revisão da definição de tarefa do Amazon ECS para a tarefa. `DesiredStatus` O status desejado para a tarefa do Amazon ECS. `KnownStatus` O status conhecido para a tarefa do Amazon ECS. `Limits` Os limites de recursos especificados nos níveis da tarefa, como CPU (expresso em vCPUs) e memória. Esse parâmetro será omitido se não houver nenhum limite de recurso definido. `PullStartedAt` O timestamp de quando começou a primeira extração de imagem do contêiner. `PullStoppedAt` O timestamp de quando a última extração de imagem do contêiner terminou. `AvailabilityZone` A zona de disponibilidade em que a tarefa está. Os metadados da zona de disponibilidade estão disponíveis apenas para tarefas do Fargate que usam a versão 1.4 ou posterior (Linux) ou 1.0.0 (Windows) da plataforma. `LaunchType` O tipo de inicialização que a tarefa está usando. Ao usar provedores de capacidade de cluster, isso indica se a tarefa está usando a infraestrutura do Fargate ou do EC2. Esses metadados `LaunchType` estão incluídos somente quando é usada a versão `1.45.0` ou posterior (Linux) ou 1.0.0 ou posterior (Windows) do agente de contêiner do Linux do Amazon ECS. `EphemeralStorageMetrics` O tamanho reservado e o uso atual do armazenamento temporário dessa tarefa. O Fargate reserva espaço no disco. Esse espaço é usado apenas pelo Fargate. Você não é cobrado por isso. Ele não é mostrado nessas métricas. Porém, você pode ver esse armazenamento adicional em outras ferramentas, como o `df`. `Utilized` O uso atual de armazenamento temporário (em MiB) dessa tarefa. `Reserved` O armazenamento temporário reservado (em MiB) dessa tarefa. O tamanho do armazenamento temporário não pode ser alterado em uma tarefa em execução. É possível especificar o objeto `ephermalStorage` na sua definição de tarefa para alterar a quantidade de armazenamento temporário. O `ephermalStorage` é especificado em GiB, não em MiB. O `ephermalStorage` e as `EphemeralStorageMetrics` só estão disponíveis na versão 1.4.0 ou posterior da plataforma Linux do Fargate. `Containers` Uma lista de metadados de contêiner para cada contêiner associado com a tarefa. `DockerId` O ID do Docker do contêiner. Quando você usa Fargate, o id é um hexadecimal de 32 dígitos seguido por um número de 10 dígitos. `Name` O nome do contêiner, conforme especificado na definição da tarefa. `DockerName` O nome do contêiner fornecido para o Docker. O agente de contêiner do Amazon ECS gera um nome exclusivo para o contêiner para evitar colisões de nomes quando várias cópias da mesma definição de tarefa são executadas em uma única instância. `Image` A imagem para o contêiner. `ImageID` O resumo SHA-256 do manifesto da imagem. Esse é o resumo que pode ser usado para extrair a imagem usando o formato `repository-url/image@sha256:digest`. `Ports` Todas as portas expostas para o contêiner. Esse parâmetro será omitido se não houver portas expostas. `Labels` Todos os rótulos aplicados ao contêiner. Esse parâmetro será omitido se não houver rótulos aplicados. `DesiredStatus` O status desejado para o contêiner do Amazon ECS. `KnownStatus` O status conhecido para o contêiner do Amazon ECS. `ExitCode` O código de saída para o contêiner. Esse parâmetro é omitido se o contêiner não foi encerrado. `Limits` Os limites de recursos especificados no nível do contêiner, como CPU (expresso em unidades de CPU) e memória. Esse parâmetro será omitido se não houver nenhum limite de recurso definido. `CreatedAt` O time stamp de quando o contêiner foi criado. Esse parâmetro será omitido se o contêiner ainda não tiver sido criado. `StartedAt` O time stamp de quando o contêiner foi iniciado. Esse parâmetro será omitido se o contêiner ainda não tiver sido iniciado. `FinishedAt` O time stamp de quando o contêiner foi interrompido. Esse parâmetro será omitido se o contêiner ainda não tiver sido interrompido. `Type` O tipo do contêiner. Os contêineres que são especificados em sua definição de tarefa são do tipo `NORMAL`. É possível ignorar outros tipos de contêineres, que são usados para o provisionamento de recursos de tarefas internas pelo agente de contêiner do Amazon ECS. `LogDriver` O driver de log que o contêiner está usando. Esses metadados `LogDriver` estão incluídos somente quando é usada a versão `1.45.0` ou posterior do agente de contêiner do Linux do Amazon ECS. `LogOptions` As opções de driver de log definidas para o contêiner. Esses metadados `LogOptions` estão incluídos somente quando é usada a versão `1.45.0` ou posterior do agente de contêiner do Linux do Amazon ECS. `ContainerARN` O nome do recurso da Amazon (ARN) do contêiner. Esses metadados `ContainerARN` estão incluídos somente quando é usada a versão `1.45.0` ou posterior do agente de contêiner do Linux do Amazon ECS. `Networks` As informações de rede para o contêiner, como o modo de rede e o endereço IP. Esse parâmetro será omitido se não houver informações de rede definidas. `Snapshotter` O snapshotter que foi usado pelo containerd para baixar essa imagem do contêiner. Os valores válidos são `overlayfs`, que é o padrão, e `soci`, usado no carregamento lento com um índice SOCI. Este parâmetro só está disponível para tarefas executadas na versão da plataforma Linux `1.4.0`. `RestartCount` O número de vezes que um contêiner foi reiniciado. Os metadados de `RestartCount` são incluídos somente se uma política de reinicialização estiver habilitada para o contêiner. Para obter mais informações, consulte [Reiniciar contêineres individuais em tarefas do Amazon ECS com políticas de reinicialização de contêineres](container-restart-policy.md). `ClockDrift` A informação sobre a diferença entre o tempo de referência e a hora do sistema. Esse recurso usa o Serviço de Sincronização Temporal da Amazon para medir a precisão do relógio e fornecer o erro de relógio vinculado aos contêineres. Para obter mais informações, consulte [Definir a hora da instância do Linux](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-time.html) no *Guia do usuário do Amazon EC2 para instâncias do Linux*. `ReferenceTime` A base da precisão do relógio. O Amazon ECS usa o padrão global Coordinated Universal Time (UTC — Tempo universal coordenado) por meio do NTP, por exemplo, `2021-09-07T16:57:44Z`. `ClockErrorBound` A medida do erro do relógio, definida como o deslocamento para UTC. Esse erro é a diferença em milissegundos entre o tempo de referência e a hora do sistema. `ClockSynchronizationStatus` Indica se a tentativa de sincronização mais recente entre a hora do sistema e o horário de referência obteve êxito. Os valores válidos são `SYNCHRONIZED` e ` NOT_SYNCHRONIZED`. `ExecutionStoppedAt` O time stamp de quando o `DesiredStatus` da tarefa mudou para `STOPPED`. Isso ocorre quando um contêiner essencial muda para `STOPPED`. # Exemplos de metadados de tarefas v4 no Amazon ECS para tarefas no Fargate A seguir, são mostrados exemplos de saídas dos endpoints de metadados de tarefas do Amazon ECS executadas no AWS Fargate. No contêiner, você pode usar o curl seguido pelo endpoint de metadados da tarefa para consultar o endpoint, por exemplo, `curl ${ECS_CONTAINER_METADATA_URI_V4}/task`. ## Exemplo de resposta de metadados de contêineres Ao consultar o endpoint `${ECS_CONTAINER_METADATA_URI_V4}`, são retornados apenas metadados sobre o próprio contêiner. Veja a seguir um exemplo de saída. ``` { "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" } ``` ## Exemplos de metadados de tarefas v4 no Amazon ECS para tarefas no Fargate Ao consultar o endpoint `${ECS_CONTAINER_METADATA_URI_V4}/task`, são retornados metadados sobre a tarefa da qual o contêiner faz parte. Veja a seguir um exemplo de saída. ``` { "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 } } ``` ## Exemplo de resposta de dados estatísticos de tarefas Ao consultar o endpoint `${ECS_CONTAINER_METADATA_URI_V4}/task/stats`, são retornadas métricas de rede sobre a tarefa da qual o contêiner faz parte. Veja a seguir um exemplo de saída. ``` { "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 } } } ```