Account - List Pool Node Counts

Referensi

Layanan:: Batch Service

Versi API:: 2024-07-01.20.0

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 {batchUrl}/nodecounts?api-version=2024-07-01.20.0

Dengan parameter opsional:

GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
batchUrl	path	True	string	URL dasar untuk semua permintaan layanan Azure Batch.
api-version	query	True	string	Versi API Klien.
$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.
maxresults	query		integer (int32) minimum: 1 maximum: 10	Jumlah maksimum item yang akan dikembalikan dalam respons.
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, default akan digunakan sebagai gantinya.

Header Permintaan

Media Types: "application/json; odata=minimalmetadata"

Nama	Jenis	Deskripsi
client-request-id	string (uuid)	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-rfc1123)	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	PoolNodeCountsListResult	Respons berisi jumlah Simpul Komputasi di setiap status Simpul Komputasi, yang dikelompokkan menurut Kumpulan. Header client-request-id: string request-id: string
Other Status Codes	BatchError	Kesalahan dari layanan Batch.

Nama

Jenis

Deskripsi

200 OK

PoolNodeCountsListResult

Respons berisi jumlah Simpul Komputasi di setiap status Simpul Komputasi, yang dikelompokkan menurut Kumpulan.

Header

client-request-id: string
request-id: string

Other Status Codes

BatchError

Kesalahan dari layanan Batch.

Keamanan

azure_auth

Alur kode autentikasi Microsoft Entra OAuth 2.0

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

Cakupan

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Authorization

Jenis: apiKey
Dalam: header

Contoh

NodeCountsPayload

Permintaan sampel

HTTP

GET account.region.batch.azure.com/nodecounts?api-version=2024-07-01.20.0

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.
ErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
NodeCounts	Jumlah Simpul Komputasi dalam setiap status Simpul Komputasi.
PoolNodeCounts	Jumlah Simpul Komputasi di setiap status untuk Kumpulan.
PoolNodeCountsListResult	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	ErrorMessage	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.

ErrorMessage

Objek

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

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

NodeCounts

Objek

Jumlah Simpul Komputasi dalam setiap status Simpul Komputasi.

Nama	Jenis	Deskripsi
creating	integer (int32)	Jumlah Simpul Komputasi dalam status pembuatan.
deallocated	integer (int32)	Jumlah Simpul Komputasi dalam status batal dialokasikan.
deallocating	integer (int32)	Jumlah Simpul Komputasi dalam status batalkan alokasi.
idle	integer (int32)	Jumlah Simpul Komputasi dalam status menganggur.
leavingPool	integer (int32)	Jumlah Simpul Komputasi dalam status leavingPool.
offline	integer (int32)	Jumlah Simpul Komputasi dalam status offline.
preempted	integer (int32)	Jumlah Simpul Komputasi dalam status yang didahului.
rebooting	integer (int32)	Jumlah Simpul Komputasi dalam status reboot.
reimaging	integer (int32)	Jumlah Simpul Komputasi dalam status penomoran ulang.
running	integer (int32)	Jumlah Simpul Komputasi dalam status berjalan.
startTaskFailed	integer (int32)	Jumlah Simpul Komputasi dalam status startTaskFailed.
starting	integer (int32)	Jumlah Simpul Komputasi dalam status awal.
total	integer (int32)	Jumlah total Simpul Komputasi.
unknown	integer (int32)	Jumlah Simpul Komputasi dalam status tidak diketahui.
unusable	integer (int32)	Jumlah Simpul Komputasi dalam status tidak dapat digunakan.
upgradingOS	integer (int32)	Jumlah Simpul Komputasi dalam status upgradeingOS.
waitingForStartTask	integer (int32)	Jumlah Simpul Komputasi dalam status waitingForStartTask.

PoolNodeCounts

Objek

Jumlah Simpul Komputasi di setiap status untuk Kumpulan.

Nama	Jenis	Deskripsi
dedicated	NodeCounts	Jumlah Simpul Komputasi khusus di setiap status.
lowPriority	NodeCounts	Jumlah Simpul Komputasi Spot/Prioritas rendah di setiap status.
poolId	string	ID Kumpulan.

PoolNodeCountsListResult

Objek

Hasil daftar jumlah Simpul Komputasi di Akun.

Nama	Jenis	Deskripsi
odata.nextLink	string	URL untuk mendapatkan serangkaian hasil berikutnya.
value	PoolNodeCounts[]	Daftar Jumlah Simpul Komputasi menurut Kumpulan.

Bagikan melalui

Account - List Pool Node Counts

Parameter URI

Header Permintaan

Respons

Keamanan

azure_auth

Cakupan

Authorization

Contoh

NodeCountsPayload

Permintaan sampel

Respon sampel

Definisi

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Sumber Daya Tambahan: