Pools - List Pool Usage Metrics

Layanan:

Batch Service

Versi API:

2025-06-01

Mencantumkan metrik penggunaan, yang dikumpulkan oleh Kumpulan di seluruh interval waktu individual, untuk Akun yang ditentukan.
Jika Anda tidak menentukan klausa $filter termasuk poolId, respons mencakup semua Kumpulan yang ada di Akun dalam rentang waktu interval agregasi yang dikembalikan. Jika Anda tidak menentukan klausa $filter termasuk startTime atau endTime, filter ini default ke waktu mulai dan berakhir dari interval agregasi terakhir yang saat ini tersedia; artinya, hanya interval agregasi terakhir yang dikembalikan.

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

Dengan parameter opsional:

GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$filter={$filter}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir akun batch (misalnya: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
$filter	query		string	Klausa $filter OData. Untuk informasi selengkapnya tentang membuat filter ini, lihat https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime	query		string (date-time)	Waktu terakhir untuk menyertakan metrik. Ini harus setidaknya dua jam sebelum waktu saat ini. Jika tidak ditentukan, ini default ke waktu akhir interval agregasi terakhir yang saat ini tersedia.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 aplikasi dapat dikembalikan.
startTime	query		string (date-time)	Waktu paling awal untuk menyertakan metrik. Ini harus setidaknya dua setengah jam sebelum waktu saat ini. Jika tidak ditentukan, ini default ke waktu mulai interval agregasi terakhir yang saat ini tersedia.
timeOut	query		integer (int32)	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik. Jika nilainya lebih besar dari 30, defaultnya akan digunakan sebagai gantinya.".

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string	Identitas permintaan yang dihasilkan penelepon, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal, misalnya 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Apakah server harus mengembalikan client-request-id dalam respons.
ocp-date		string (date-time-rfc7231)	Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.

Respons

Nama	Jenis	Deskripsi
200 OK	BatchPoolListUsageMetricsResult	Permintaan telah berhasil. Header ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Respons kesalahan tak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://batch.core.windows.net//.default

Contoh

Pool list usage metrics

Permintaan sampel

HTTP

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

Respon sampel

Kode status:

200

{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
BatchErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
BatchPoolListUsageMetricsResult	Hasil daftar metrik penggunaan untuk Akun.
BatchPoolUsageMetrics	Metrik penggunaan untuk Kumpulan di seluruh interval agregasi.

BatchError

Objek

Respons kesalahan diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	BatchErrorMessage	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	BatchErrorDetail[]	Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Objek

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
key	string	Pengidentifikasi yang menentukan arti properti Nilai.
value	string	Informasi tambahan yang disertakan dengan respons kesalahan.

BatchErrorMessage

Objek

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
lang	string	Kode bahasa pesan kesalahan.
value	string	Teks pesan.

BatchPoolListUsageMetricsResult

Objek

Hasil daftar metrik penggunaan untuk Akun.

Nama	Jenis	Deskripsi
odata.nextLink	string (uri)	URL untuk mendapatkan kumpulan hasil berikutnya.
value	BatchPoolUsageMetrics[]	Data metrik penggunaan Kumpulan.

BatchPoolUsageMetrics

Objek

Metrik penggunaan untuk Kumpulan di seluruh interval agregasi.

Nama	Jenis	Deskripsi
endTime	string (date-time)	Waktu akhir interval agregasi yang dicakup oleh entri ini.
poolId	string	ID Kumpulan yang metriknya dikumpulkan dalam entri ini.
startTime	string (date-time)	Waktu mulai interval agregasi yang tercakup dalam entri ini.
totalCoreHours	number (float)	Total jam inti yang digunakan dalam Kumpulan selama interval agregasi ini.
vmSize	string	Ukuran komputer virtual di Kumpulan. Semua VM dalam Kumpulan memiliki ukuran yang sama. Untuk informasi tentang ukuran komputer virtual yang tersedia di Kumpulan, lihat Memilih ukuran VM untuk Simpul Komputasi di Kumpulan Azure Batch (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).