Endpoint di metadati Amazon ECS Task versione 2

Importante

L'endpoint dei metadati delle attività versione 2 non viene più gestito attivamente. Ti consigliamo di aggiornare l'endpoint dei metadati delle attività versione 4 per ottenere le informazioni più recenti sull'endpoint dei metadati. Per ulteriori informazioni, consulta Endpoint di metadati Amazon ECS Task versione 4.

A partire dalla versione 1.17.0 di Amazon ECS Container Agent, sono disponibili diversi metadati delle attività e statistiche Docker per le attività che utilizzano la modalità di awsvpc rete su un HTTP endpoint fornito dall'agente Amazon Container. ECS

Tutti i contenitori appartenenti alle attività avviate con la modalità di awsvpc rete ricevono un indirizzo locale all'interno di un intervallo di IPv4 indirizzi locale del collegamento predefinito. Quando un contenitore interroga l'endpoint dei metadati, l'agente Amazon ECS Container può determinare a quale attività appartiene il contenitore in base al suo indirizzo IP univoco e vengono restituiti i metadati e le statistiche per quell'attività.

Abilitazione dei metadati dei processi

La caratteristica dei metadati delle attività versione 2 è abilitata di default per:

• Processi che utilizzano il tipo di avvio Fargate e la versione della piattaforma v1.1.0 o versioni successive. Per ulteriori informazioni, consulta Versioni della piattaforma Fargate per Amazon ECS.

• Attività che utilizzano il tipo di EC2 avvio che utilizzano anche la modalità di awsvpc rete e vengono avviate sull'infrastruttura Amazon EC2 Linux che esegue almeno la versione 1.17.0 dell'agente ECS container Amazon o sull'infrastruttura Amazon EC2 Windows che esegue almeno una versione 1.54.0 dell'agente ECS container Amazon. Per ulteriori informazioni, consulta Gestione delle istanze di container Amazon ECS Linux.

Questa caratteristica può essere supportata sulle istanze di container precedenti aggiornando l'agente alla versione più recente. Per ulteriori informazioni, consulta Aggiornamento dell'agente ECS container Amazon.

Percorsi per gli endpoint dei metadati dei processi

I seguenti API endpoint sono disponibili per i container:

169.254.170.2/v2/metadata

Questo endpoint restituisce i metadati JSON per l'attività, incluso un elenco del contenitore IDs e i nomi di tutti i contenitori associati all'attività. Per ulteriori informazioni sulle risposte per questo endpoint, consulta Risposta ai metadati JSON dell'attività.

169.254.170.2/v2/metadata/<container-id>

Questo endpoint restituisce i metadati JSON per l'ID del contenitore Docker specificato.

169.254.170.2/v2/metadata/taskWithTags

Questo percorso restituisce i metadati per l'attività inclusa nell'/taskendpoint oltre ai tag dell'istanza dell'attività e del contenitore che possono essere recuperati utilizzando. ListTagsForResource API

169.254.170.2/v2/stats

Questo endpoint restituisce le statistiche Docker JSON per tutti i contenitori associati all'attività. Per ulteriori informazioni su ciascuna delle statistiche restituite, consulta la documentazione ContainerStatsdi API Docker.

169.254.170.2/v2/stats/<container-id>

Questo endpoint restituisce le statistiche Docker JSON per l'ID del contenitore Docker specificato. Per ulteriori informazioni su ciascuna delle statistiche restituite, consulta la documentazione ContainerStatsDocker. API

Risposta ai metadati JSON dell'attività

Le seguenti informazioni vengono restituite dalla risposta del task metadata endpoint ()169.254.170.2/v2/metadata. JSON

Cluster

L'Amazon Resource Name (ARN) o il nome breve del ECS cluster Amazon a cui appartiene l'attività.

TaskARN

L'Amazon Resource Name completo (ARN) dell'attività a cui appartiene il contenitore.

Family

La famiglia della definizione di ECS attività Amazon per l'attività.

Revision

La revisione della definizione dell'ECSattività Amazon per l'attività.

DesiredStatus

Lo stato desiderato per l'attività da AmazonECS.

KnownStatus

Lo stato noto dell'attività di AmazonECS.

Limits

I limiti di risorse specificati a livello di attività, ad esempio CPU (espressi invCPUs) e memoria. Se non ci sono limiti di risorse definiti, questo parametro viene omesso.

PullStartedAt

Il timestamp dell'inizio della prima estrazione per l'immagine del container.

PullStoppedAt

Il timestamp del termine dell'ultima estrazione per l'immagine del container.

AvailabilityZone

La zona di disponibilità in cui si trova l'attività.

Nota

I metadati della zona di disponibilità sono disponibili solo per i processi Fargate che utilizzano la versione 1.4 o successiva della piattaforma (Linux) o 1.0.0 o successiva (Windows).

Containers

Un elenco di metadati dei container per ogni container associato all'attività.

DockerId

L'ID Docker per il container.

Name

Il nome del container come specificato nella definizione di attività.

DockerName

Il nome del container fornito a Docker. L'agente ECS container Amazon genera un nome univoco per il contenitore per evitare collisioni di nomi quando più copie della stessa definizione di attività vengono eseguite su una singola istanza.

Image

L'immagine per il container.

ImageID

Il digest SHA -256 per l'immagine.

Ports

Eventuali porte esposte per il container. Se non ci sono porte esposte, questo parametro viene omesso.

Labels

Eventuali etichette applicate al container. Se non ci sono etichette applicate, questo parametro viene omesso.

DesiredStatus

Lo stato desiderato per il container da AmazonECS.

KnownStatus

Lo stato noto del container fornito da AmazonECS.

ExitCode

Il codice di uscita per il container. Se il container non si è chiuso, questo parametro viene omesso.

Limits

I limiti di risorse specificati a livello di contenitore, ad esempio CPU (espressi in CPU unità) e memoria. Se non ci sono limiti di risorse definiti, questo parametro viene omesso.

CreatedAt

Il timestamp della creazione del container. Se il container non è ancora stato creato, questo parametro viene omesso.

StartedAt

Il timestamp dell'avvio del container. Se il container non è ancora stato avviato, questo parametro viene omesso.

FinishedAt

Il timestamp dell'arresto del container. Se il container non è ancora stato arrestato, questo parametro viene omesso.

Type

Il tipo di container. I container specificati nella definizione di attività sono di tipo NORMAL. Puoi ignorare altri tipi di contenitori, utilizzati per il provisioning interno delle risorse delle attività dall'agente Amazon ECS Container.

Networks

Le informazioni di rete per il container, ad esempio la modalità di rete e l'indirizzo IP. Se non ci sono informazioni di rete definite, questo parametro viene omesso.

ClockDrift

Le informazioni sulla differenza tra l'ora di riferimento e l'ora del sistema. Questo vale per il sistema operativo Linux. Questa funzionalità utilizza Amazon Time Sync Service per misurare la precisione dell'orologio e fornire il limite di errore dell'orologio per i contenitori. Per ulteriori informazioni, consulta Impostare l'ora per l'istanza Linux nella Amazon EC2 User Guide for Linux instances.

ReferenceTime

La base della precisione dell'orologio. Amazon ECS utilizza lo standard globale Coordinated Universal Time (UTC) tramiteNTP, ad esempio2021-09-07T16:57:44Z.

ClockErrorBound

La misura dell'errore dell'orologio, definita come l'offset diUTC. Questo errore è la differenza in millisecondi tra l'ora di riferimento e l'ora del sistema.

ClockSynchronizationStatus

Indica se il tentativo di sincronizzazione più recente tra l'ora del sistema e l'ora di riferimento ha avuto esito positivo.

I valori validi sono SYNCHRONIZED e NOT_SYNCHRONIZED.

ExecutionStoppedAt

Il timestamp del momento in cui le attività DesiredStatus sono passate a essere STOPPED. Questo si verifica quando un container fondamentale passa allo stato STOPPED.

Esempio di risposta dei metadati del processo

La JSON risposta seguente si riferisce a un'attività a contenitore singolo.

{
  "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"
}