Titik akhir metadata tugas Amazon ECS versi 2

penting

Titik akhir metadata tugas versi 2 tidak lagi dipertahankan secara aktif. Sebaiknya perbarui titik akhir metadata tugas versi 4 untuk mendapatkan informasi titik akhir metadata terbaru. Untuk informasi selengkapnya, lihat Titik akhir metadata tugas Amazon ECS versi 4.

Dimulai dengan versi 1.17.0 dari agen kontainer Amazon ECS, berbagai metadata tugas dan statistik Docker tersedia untuk tugas yang menggunakan mode awsvpc jaringan di titik akhir HTTP yang disediakan oleh agen kontainer Amazon ECS.

Semua kontainer milik tugas yang diluncurkan dengan mode jaringan awsvpc menerima alamat IPv4 lokal dalam rentang alamat tautan lokal yang telah ditetapkan. Saat kontainer menanyakan titik akhir metadata, agen kontainer Amazon ECS dapat menentukan tugas mana yang dimiliki wadah berdasarkan alamat IP uniknya, dan metadata serta statistik untuk tugas tersebut dikembalikan.

Mengaktifkan metadata tugas

penting

Mengaktifkan metadata tugas

Fitur metadata tugas versi 2 diaktifkan secara default untuk hal berikut:

Tugas menggunakan Fargate yang menggunakan versi platform v1.1.0 atau yang lebih baru. Untuk informasi selengkapnya, lihat Versi platform Fargate untuk Amazon ECS.
Tugas menggunakan EC2 yang juga menggunakan mode awsvpc jaringan dan diluncurkan pada infrastruktur Amazon EC2 Linux yang menjalankan setidaknya versi 1.17.0 dari agen kontainer Amazon ECS atau pada infrastruktur Amazon EC2 Windows yang menjalankan setidaknya versi 1.54.0 agen kontainer Amazon ECS. Untuk informasi selengkapnya, lihat Manajemen instans kontainer Amazon ECS Linux.

Anda dapat menambahkan dukungan untuk fitur ini pada instans kontainer yang lebih lama dengan memperbarui agen ke versi terbaru. Untuk informasi selengkapnya, lihat Memperbarui agen kontainer Amazon ECS.

Jalur titik akhir metadata tugas

Titik akhir API tersedia untuk kontainer:

169.254.170.2/v2/metadata: Titik akhir ini mengembalikan JSON metadata untuk tugas, termasuk daftar ID kontainer dan nama semua kontainer yang terkait dengan tugas tersebut. Untuk informasi selengkapnya tentang respons titik akhir ini, lihat Respons JSON metadata tugas.
169.254.170.2/v2/metadata/<container-id>: Titik akhir ini mengembalikan JSON metadata untuk ID kontainer Docker ditentukan.
169.254.170.2/v2/metadata/taskWithTags: Jalur ini mengembalikan metadata pada tugas yang disertakan dalam titik akhir /task selain tugas dan tanda instans kontainer yang dapat diambil menggunakan API ListTagsForResource.
169.254.170.2/v2/stats: Titik akhir ini mengembalikan JSON statistik Docker pada semua kontainer yang terkait dengan tugas. Untuk informasi selengkapnya tentang masing-masing statistik yang dikembalikan, lihat ContainerStats dokumentasi Docker API.
169.254.170.2/v2/stats/<container-id>: Titik akhir ini mengembalikan JSON statistik Docker untuk ID kontainer Docker tertentu. Untuk informasi selengkapnya tentang masing-masing statistik yang dikembalikan, lihat ContainerStats dokumentasi Docker API.

Respons JSON metadata tugas

Informasi berikut dikembalikan dari respons JSON titik akhir metadata tugas (169.254.170.2/v2/metadata).

Cluster

Nama Sumber Daya Amazon (ARN) atau nama pendek dari cluster Amazon ECS tempat tugas tersebut berada.

TaskARN

Nama Sumber Daya Amazon (ARN) dari tugas tempat wadah tersebut berada.

Family

Keluarga definisi tugas Amazon ECS untuk tugas tersebut.

Revision

Revisi definisi tugas Amazon ECS untuk tugas tersebut.

DesiredStatus

Status yang diinginkan untuk tugas dari Amazon ECS.

KnownStatus

Status yang diketahui untuk tugas dari Amazon ECS.

Limits

Batas sumber daya yang ditentukan pada tingkat tugas, seperti CPU (dinyatakan dalam vCPU) dan memori. Parameter ini dihilangkan jika tidak ada batasan sumber daya yang ditentukan.

PullStartedAt

Stempel waktu saat penarikan gambar kontainer pertama dimulai.

PullStoppedAt

Stempel waktu saat penarikan gambar kontainer terakhir selesai.

AvailabilityZone

Zona Ketersediaan tempat tugas berada.

catatan

Metadata Zona Ketersediaan hanya tersedia untuk tugas Fargate menggunakan platform versi 1.4 atau yang lebih baru (Linux) atau 1.0.0 atau yang lebih baru (Windows).

Containers

Daftar metadata kontainer untuk setiap wadah yang terkait dengan tugas.

DockerId: ID Docker untuk wadah.
Name: Nama wadah seperti yang ditentukan dalam definisi tugas.
DockerName: Nama wadah yang diberikan ke Docker. Agen kontainer Amazon ECS menghasilkan nama unik untuk wadah untuk menghindari tabrakan nama saat beberapa salinan definisi tugas yang sama dijalankan pada satu instans.
Image: Gambar untuk wadah.
ImageID: In SHA-256 tisari manifestasi gambar. Ini adalah ringkasan yang dapat digunakan untuk menarik gambar menggunakan formatrepository-url/image@sha256:digest.
Ports: Setiap port terbuka untuk wadah. Parameter ini dihilangkan jika tidak ada port yang terbuka.
Labels: Label apa pun diterapkan pada wadah. Parameter ini dihilangkan jika tidak ada label yang diterapkan.
DesiredStatus: Status yang diinginkan untuk wadah dari Amazon ECS.
KnownStatus: Status yang diketahui untuk wadah dari Amazon ECS.
ExitCode: Kode keluar untuk wadah. Parameter ini dihilangkan jika wadah belum keluar.
Limits: Batas sumber daya yang ditentukan pada tingkat kontainer, seperti CPU (dinyatakan dalam unit CPU) dan memori. Parameter ini dihilangkan jika tidak ada batasan sumber daya yang ditentukan.
CreatedAt: Cap waktu saat wadah dibuat. Parameter ini dihilangkan jika wadah belum dibuat.
StartedAt: Cap waktu saat wadah dimulai. Parameter ini dihilangkan jika wadah belum dimulai.
FinishedAt: Cap waktu saat wadah berhenti. Parameter ini dihilangkan jika wadah belum berhenti.
Type: Jenis wadah. Wadah yang ditentukan dalam definisi tugas Anda adalah tipeNORMAL. Anda dapat mengabaikan jenis kontainer lain, yang digunakan untuk penyediaan sumber daya tugas internal oleh agen kontainer Amazon ECS.
Networks: Informasi jaringan untuk wadah, seperti mode jaringan dan alamat IP. Parameter ini dihilangkan jika tidak ada informasi jaringan yang ditentukan.

ClockDrift

Informasi tentang perbedaan antara waktu referensi dan waktu sistem. Ini berlaku untuk sistem operasi Linux. Kemampuan ini menggunakan Layanan Sinkronisasi Waktu Amazon untuk mengukur akurasi jam dan memberikan kesalahan jam yang terikat untuk wadah. Untuk informasi selengkapnya, lihat Meng atur waktu untuk instans Linux Anda di Panduan Pengguna Amazon EC2 untuk inst ans Linux.

ReferenceTime

Dasar akurasi jam. Amazon ECS menggunakan standar global Coordinated Universal Time (UTC) melalui NTP, misalnya. 2021-09-07T16:57:44Z

ClockErrorBound

Ukuran kesalahan jam, didefinisikan sebagai offset ke UTC. Kesalahan ini adalah perbedaan dalam milidetik antara waktu referensi dan waktu sistem.

ClockSynchronizationStatus

Menunjukkan apakah upaya sinkronisasi terbaru antara waktu sistem dan waktu referensi berhasil.

Nilai yang valid adalah SYNCHRONIZED dan NOT_SYNCHRONIZED.

ExecutionStoppedAt

Cap waktu untuk saat tugas DesiredStatus dipindahkanSTOPPED. Ini terjadi ketika wadah penting pindah keSTOPPED.

Respons metadata tugas contoh

Respons JSON berikut adalah untuk tugas wadah tunggal.


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

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Contoh metadata tugas v3

Metadata tugas tersedia untuk tugas di Fargate