Fargate のタスク用の Amazon ECS タスクメタデータエンドポイントバージョン 4

重要

Amazon EC2 インスタンスでホストされている Amazon ECS タスクを使用している場合は、「Amazon ECS タスクのメタデータエンドポイント」を参照してください。

Fargateのプラットフォームバージョン1.4.0以降、ECS_CONTAINER_METADATA_URI_V4 という名前の環境変数がタスク内の各コンテナに挿入されます。タスクメタデータエンドポイントバージョン 4 に対してクエリを実行すると、さまざまなタスクメタデータおよび Docker 統計をタスクで利用できます。

タスクメタデータエンドポイントバージョン 4 は、バージョン 3 と同じように動作しますが、コンテナとタスクに関する追加のネットワークメタデータを提供します。/stats エンドポイントにクエリを実行するときにも追加のネットワークメトリクスを使用できます。

タスクメタデータエンドポイントは、プラットフォームバージョン 1.4.0 以降を使用する AWS Fargate 上で実行される、すべての Amazon ECS タスクに対してデフォルトでオンになっています。

注記

新しいタスクメタデータエンドポイントバージョンを今後作成する必要がないように、追加のメタデータをバージョン 4 の出力に追加できます。既存のメタデータが削除されたり、メタデータのフィールド名が変更されたりすることはありません。

Fargate タスクメタデータエンドポイントバージョン 4 のパス

次のタスクメタデータエンドポイントをコンテナで使用できます。

${ECS_CONTAINER_METADATA_URI_V4}

このパスはコンテナのメタデータを返します。

${ECS_CONTAINER_METADATA_URI_V4}/task

このパスはタスクのメタデータを返します。これには、タスクに関連付けられたすべてのコンテナのコンテナ ID および名前のリストが含まれています。このエンドポイントのレスポンスの詳細については、「Fargate のタスク用の Amazon ECS タスクメタデータ v4 JSON レスポンス」を参照してください。

${ECS_CONTAINER_METADATA_URI_V4}/stats

このパスは Docker コンテナの Docker 統計を返します。返される各統計の詳細については、Docker API ドキュメントの「ContainerStats」を参照してください。

注記

AWS FargateでのAmazon ECS タスクは、コンテナの統計を返す前にコンテナを約 1 秒間実行する必要があります。

${ECS_CONTAINER_METADATA_URI_V4}/task/stats

このパスはタスクに関連付けられたすべてのコンテナの Docker 統計を返します。返される各統計の詳細については、Docker API ドキュメントの「ContainerStats」を参照してください。

注記

AWS FargateでのAmazon ECS タスクは、コンテナの統計を返す前にコンテナを約 1 秒間実行する必要があります。