Amazon ECS タスクメタデータ V4 JSON レスポンス

次の情報が、タスクメタデータエンドポイント (${ECS_CONTAINER_METADATA_URI_V4}/task) JSON レスポンスから返されます。これには、タスク内の各コンテナのメタデータに加えて、タスクに関連付けられたメタデータも含まれます。

Cluster

タスクが属する Amazon ECS クラスターの Amazon リソースネーム (ARN)または短縮名。

ServiceName

タスクが属しているサービスの名前。ServiceName は、タスクがサービスに関連付けられている場合、Amazon EC2 と Amazon ECS Anywhere コンテナインスタンスに表示されます。

注記

この ServiceName メタデータは、Amazon ECS コンテナエージェントのバージョン 1.63.1、もしくはそれ以降を使用している場合にのみ含まれます。

VPCID

Amazon EC2 コンテナインスタンスの VPC ID。このフィールドは、Amazon EC2 インスタンスでのみ表示されます。

注記

この VPCID メタデータは、Amazon ECS コンテナエージェントのバージョン 1.63.1、もしくはそれ以降を使用している場合にのみ含まれます。

TaskARN

コンテナが属しているタスクの Amazon リソースネーム (ARN)。

Family

タスクの Amazon ECS タスク定義のファミリー。

Revision

タスクの Amazon ECS タスク定義のリビジョン。

DesiredStatus

Amazon ECSからのタスクの望ましいステータス。

KnownStatus

Amazon ECS からのタスクの既知のステータス。

Limits

CPU (vCPU で表される) やメモリなど、タスク レベルで指定されたリソースの制限。リソースの制限が定義されていない場合はこのパラメータは省略されます。

PullStartedAt

最初のコンテナイメージのプル開始時のタイムスタンプ。

PullStoppedAt

最後のコンテナイメージのプル終了時のタイムスタンプ。

AvailabilityZone

タスクがあるアベイラビリティーゾーン。

注記

アベイラビリティーゾーンのメタデータは、プラットフォームバージョン 1.4 以降 (Linux) または 1.0.0 (Windows) を使用する Fargate タスクでのみ使用できます。

LaunchType

タスクが使用している起動タイプ。クラスター容量プロバイダーを使用する場合、タスクが Fargate インフラストラクチャと EC2 インフラストラクチャのいずれを使用しているかを示します。

注記

このLaunchTypeメタデータは、Amazon ECS Linux コンテナエージェントのバージョン1.45.0 以降 (Linux) または 1.0.0 以降 (Windows) を使用している場合にのみ含まれます。

Containers

タスクに関連付けられている各コンテナのコンテナメタデータのリスト。

DockerId

コンテナの Docker ID。

Fargate を使用する場合、IDは32桁の16進数に10桁の数字が続きます。

Name

タスク定義で指定されたコンテナの名前。

DockerName

Docker に提供されたコンテナの名前。Amazon ECSコンテナエージェントはコンテナに一意の名前を生成し、同じタスク定義の複数のコピーが単一のインスタンスで実行される場合に名前の競合を回避します。

Image

コンテナのイメージ。

ImageID

イメージマニフェストの SHA-256 ダイジェスト。これは、repository-url/image@sha256:digest 形式を使用してイメージをプルするために使用できるダイジェストです。

Ports

コンテナに対して公開されている任意のポート。公開ポートがない場合はこのパラメータは省略されます。

Labels

コンテナに適用された任意のラベル。ラベルが適用されていない場合はこのパラメータは省略されます。

DesiredStatus

Amazon ECSからのコンテナの望ましいステータス。

KnownStatus

Amazon ECS からのコンテナの既知のステータス。

ExitCode

コンテナの終了コード。このパラメータは、コンテナが終了していない場合は省略されます。

Limits

CPU (CPU 単位で表される) やメモリなど、コンテナレベルで指定されたリソースの制限。リソースの制限が定義されていない場合はこのパラメータは省略されます。

CreatedAt

コンテナ作成時のタイムスタンプ。このパラメータは、コンテナがまだ作成されていない場合は省略されます。

StartedAt

コンテナ起動時のタイムスタンプ。このパラメータは、コンテナがまだ起動していない場合は省略されます。

FinishedAt

コンテナ停止時のタイムスタンプ。このパラメータは、コンテナがまだ停止していない場合は省略されます。

Type

コンテナのタイプ。タスク定義で指定されているコンテナのタイプは NORMAL です。他のコンテナタイプは無視してかまいません。これらはAmazon ECS コンテナエージェントによってプロビジョニングされる内部タスクリソースで使用されます。

LogDriver

コンテナに使用されるログドライバー。

注記

このLogDriverメタデータは、Amazon ECS Linux コンテナエージェントのバージョン1.45.0、もしくはそれ以降を使用している場合にのみ含まれます。

LogOptions

コンテナに定義されたログドライバオプション。

注記

このLogOptionsメタデータは、Amazon ECS Linux コンテナエージェントのバージョン1.45.0、もしくはそれ以降を使用している場合にのみ含まれます。

ContainerARN

コンテナの Amazon リソースネーム (ARN)。

注記

このContainerARNメタデータは、Amazon ECS Linux コンテナエージェントのバージョン1.45.0、もしくはそれ以降を使用している場合にのみ含まれます。

Networks

ネットワークモードや IP アドレスなど、コンテナのネットワーク情報。ネットワーク情報が定義されていない場合はこのパラメータは省略されます。

RestartCount

コンテナが再起動された回数。

注記

RestartCount メタデータが含まれるのは、コンテナの再起動ポリシーが有効になっている場合のみです。詳細については、「コンテナ再起動ポリシーを使用して Amazon ECS タスク内の個々のコンテナを再起動する」を参照してください。

ExecutionStoppedAt

タスクの DesiredStatus が STOPPED に移行した時のタイムスタンプ。これは、必須コンテナが STOPPED に移行したときに発生します。