Pools - List Pool Node Counts

Layanan:

Batch Service

Versi API:

2025-06-01

Mendapatkan jumlah Simpul Komputasi di setiap status, dikelompokkan menurut Kumpulan. Perhatikan bahwa angka yang dikembalikan mungkin tidak selalu diperbarui. Jika Anda memerlukan jumlah simpul yang tepat, gunakan kueri daftar.

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

Dengan parameter opsional:

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$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-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 aplikasi dapat dikembalikan.
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	BatchPoolNodeCountsListResult	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

NodeCountsPayload

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 11
      }
    }
  ]
}

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.
BatchNodeCounts	Jumlah Simpul Komputasi dalam setiap status Simpul Komputasi.
BatchPoolNodeCounts	Jumlah Simpul Komputasi di setiap status untuk Kumpulan.
BatchPoolNodeCountsListResult	Hasil daftar jumlah Simpul Komputasi di Akun.

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.

BatchNodeCounts

Objek

Jumlah Simpul Komputasi dalam setiap status Simpul Komputasi.

Nama	Jenis	Deskripsi
creating	integer (int32)	Jumlah Node Komputasi dalam status pembuatan.
deallocated	integer (int32)	Jumlah Node Komputasi dalam status yang dibatalkan.
deallocating	integer (int32)	Jumlah Node Komputasi dalam status pembatalan alokasi.
idle	integer (int32)	Jumlah Compute Node dalam status idle.
leavingPool	integer (int32)	Jumlah Compute Node dalam status leavingPool.
offline	integer (int32)	Jumlah Node Komputasi dalam status offline.
preempted	integer (int32)	Jumlah Node Komputasi dalam status preempted.
rebooting	integer (int32)	Jumlah Node Komputasi dalam status rebooting.
reimaging	integer (int32)	Jumlah Node Komputasi dalam status pencitraan ulang.
running	integer (int32)	Jumlah Node Komputasi dalam status berjalan.
startTaskFailed	integer (int32)	Jumlah Node Komputasi dalam status startTaskFailed.
starting	integer (int32)	Jumlah Node Komputasi dalam status awal.
total	integer (int32)	Jumlah total Node Komputasi.
unknown	integer (int32)	Jumlah Node Komputasi dalam status tidak diketahui.
unusable	integer (int32)	Jumlah Compute Node dalam status tidak dapat digunakan.
upgradingOS	integer (int32)	Jumlah Node Komputasi dalam status upgradeOS.
waitingForStartTask	integer (int32)	Jumlah Node Komputasi dalam status waitingForStartTask.

BatchPoolNodeCounts

Objek

Jumlah Simpul Komputasi di setiap status untuk Kumpulan.

Nama	Jenis	Deskripsi
dedicated	BatchNodeCounts	Jumlah Node Komputasi khusus di setiap status.
lowPriority	BatchNodeCounts	Jumlah Node Komputasi Spot/Prioritas Rendah di setiap negara bagian.
poolId	string	ID kolam.

BatchPoolNodeCountsListResult

Objek

Hasil daftar jumlah Simpul Komputasi di Akun.

Nama	Jenis	Deskripsi
odata.nextLink	string (uri)	URL untuk mendapatkan kumpulan hasil berikutnya.
value	BatchPoolNodeCounts[]	Daftar jumlah Node Komputasi berdasarkan Kumpulan.