Pools - Resize Pool

Layanan:

Batch Service

Versi API:

2025-06-01

Mengubah jumlah Simpul Komputasi yang ditetapkan ke Kumpulan.
Anda hanya dapat mengubah ukuran Kumpulan saat status alokasinya stabil. Jika Kumpulan sudah mengubah ukuran, permintaan gagal dengan kode status 409. Saat Anda mengubah ukuran Kumpulan, status alokasi Kumpulan berubah dari stabil menjadi mengubah ukuran. Anda tidak dapat mengubah ukuran Kumpulan yang dikonfigurasi untuk penskalaan otomatis. Jika Anda mencoba melakukan ini, layanan Batch mengembalikan kesalahan 409. Jika Anda mengubah ukuran Kumpulan ke bawah, layanan Batch memilih Simpul Komputasi mana yang akan dihapus. Untuk menghapus Simpul Komputasi tertentu, gunakan Pool remove Compute Nodes API sebagai gantinya.

POST {endpoint}/pools/{poolId}/resize?api-version=2025-06-01

Dengan parameter opsional:

POST {endpoint}/pools/{poolId}/resize?api-version=2025-06-01&timeOut={timeOut}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir akun batch (misalnya: https://batchaccount.eastus2.batch.azure.com).
poolId	path	True	string	ID Kumpulan yang akan didapatkan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
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

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

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.
If-Modified-Since		string (date-time-rfc7231)	Tanda waktu yang menunjukkan waktu terakhir yang dimodifikasi dari sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika sumber daya pada layanan telah dimodifikasi sejak waktu yang ditentukan.
If-Unmodified-Since		string (date-time-rfc7231)	Tanda waktu yang menunjukkan waktu terakhir yang dimodifikasi dari sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika sumber daya pada layanan belum dimodifikasi sejak waktu yang ditentukan.
If-Match		string	Nilai ETag yang terkait dengan versi sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika ETag sumber daya saat ini pada layanan sama persis dengan nilai yang ditentukan oleh klien.
If-None-Match		string	Nilai ETag yang terkait dengan versi sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika ETag sumber daya saat ini pada layanan tidak cocok dengan nilai yang ditentukan oleh klien.

Isi Permintaan

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

Nama	Jenis	Deskripsi
nodeDeallocationOption	BatchNodeDeallocationOption	Menentukan apa yang harus dilakukan dengan Simpul Komputasi dan tugas yang sedang berjalan jika ukuran Kumpulan menurun. Nilai defaultnya adalah antrean ulang.
resizeTimeout	string (duration)	Batas waktu untuk alokasi Simpul ke Kumpulan atau penghapusan Simpul Komputasi dari Kumpulan. Nilai defaultnya adalah 15 menit. Nilai minimum adalah 5 menit. Jika Anda menentukan nilai kurang dari 5 menit, layanan Batch mengembalikan kesalahan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).
targetDedicatedNodes	integer (int32)	Jumlah Simpul Komputasi khusus yang diinginkan di Kumpulan.
targetLowPriorityNodes	integer (int32)	Jumlah Simpul Komputasi Spot/Berprioritas rendah yang diinginkan di Kumpulan.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai. Header DataServiceId: string 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 resize

Permintaan sampel

HTTP

POST {endpoint}/pools/resizePool/resize?api-version=2025-06-01



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Respon sampel

Kode status:

202

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.
BatchNodeDeallocationOption	Enum BatchNodeDeallocationOption
BatchPoolResizeOptions	Parameter untuk mengubah ukuran Kumpulan Azure Batch.

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.

BatchNodeDeallocationOption

Enumerasi

Enum BatchNodeDeallocationOption

Nilai	Deskripsi
requeue	Hentikan proses Tugas yang sedang berjalan dan antre ulang Tugas. Tugas akan berjalan lagi ketika Simpul Komputasi tersedia. Hapus Simpul Komputasi segera setelah Tugas dihentikan.
terminate	Hentikan tugas yang sedang berjalan. Tugas akan diselesaikan dengan failureInfo yang menunjukkan bahwa mereka dihentikan, dan tidak akan berjalan lagi. Hapus Simpul Komputasi segera setelah Tugas dihentikan.
taskcompletion	Perbolehkan Tugas yang sedang berjalan selesai. Jadwalkan tidak ada Tugas baru saat menunggu. Hapus Simpul Komputasi ketika semua Tugas telah selesai.
retaineddata	Tidak digunakan lagi, kami menyarankan Anda untuk mengunggah data tugas ke Azure Storage dalam tugas Anda dan menggunakannya TaskCompletion sebagai gantinya. Perbolehkan Tugas yang sedang berjalan selesai, lalu tunggu semua periode retensi data Tugas kedaluwarsa. Jadwalkan tidak ada Tugas baru saat menunggu. Hapus Simpul Komputasi ketika semua periode retensi Tugas telah kedaluwarsa.

BatchPoolResizeOptions

Objek

Parameter untuk mengubah ukuran Kumpulan Azure Batch.

Nama	Jenis	Deskripsi
nodeDeallocationOption	BatchNodeDeallocationOption	Menentukan apa yang harus dilakukan dengan Simpul Komputasi dan tugas yang sedang berjalan jika ukuran Kumpulan menurun. Nilai defaultnya adalah antrean ulang.
resizeTimeout	string (duration)	Batas waktu untuk alokasi Simpul ke Kumpulan atau penghapusan Simpul Komputasi dari Kumpulan. Nilai defaultnya adalah 15 menit. Nilai minimum adalah 5 menit. Jika Anda menentukan nilai kurang dari 5 menit, layanan Batch mengembalikan kesalahan; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk).
targetDedicatedNodes	integer (int32)	Jumlah Simpul Komputasi khusus yang diinginkan di Kumpulan.
targetLowPriorityNodes	integer (int32)	Jumlah Simpul Komputasi Spot/Berprioritas rendah yang diinginkan di Kumpulan.