Pools - Enable Pool Auto Scale

Layanan:

Batch Service

Versi API:

2025-06-01

Mengaktifkan penskalaan otomatis untuk Kumpulan.
Anda tidak dapat mengaktifkan penskalakan otomatis pada Kumpulan jika operasi mengubah ukuran sedang berlangsung pada Kumpulan. Jika penskalaan otomatis Kumpulan saat ini dinonaktifkan, Anda harus menentukan rumus skala otomatis yang valid sebagai bagian dari permintaan. Jika penskalaan otomatis Kumpulan sudah diaktifkan, Anda dapat menentukan rumus skala otomatis baru dan/atau interval evaluasi baru. Anda tidak dapat memanggil API ini untuk Kumpulan yang sama lebih dari sekali setiap 30 detik.

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

Dengan parameter opsional:

POST {endpoint}/pools/{poolId}/enableautoscale?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
autoScaleEvaluationInterval	string (duration)	Interval waktu untuk menyesuaikan ukuran Kumpulan secara otomatis sesuai dengan rumus skala otomatis. Nilai defaultnya adalah 15 menit. Nilai minimum dan maksimum masing-masing adalah 5 menit dan 168 jam. Jika Anda menentukan nilai kurang dari 5 menit atau lebih besar dari 168 jam, layanan Batch menolak permintaan dengan kesalahan nilai properti yang tidak valid; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk). Jika Anda menentukan interval baru, maka jadwal evaluasi skala otomatis yang ada akan dihentikan dan jadwal evaluasi skala otomatis baru akan dimulai, dengan waktu mulai adalah waktu ketika permintaan ini dikeluarkan.
autoScaleFormula	string	Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan. Nilai defaultnya adalah 15 menit. Nilai minimum dan maksimum masing-masing adalah 5 menit dan 168 jam. Jika Anda menentukan nilai kurang dari 5 menit atau lebih besar dari 168 jam, layanan Batch menolak permintaan dengan kesalahan nilai properti yang tidak valid; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk). Jika Anda menentukan interval baru, maka jadwal evaluasi skala otomatis yang ada akan dihentikan dan jadwal evaluasi skala otomatis baru akan dimulai, dengan waktu mulai adalah waktu ketika permintaan ini dikeluarkan.

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan telah berhasil. 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 enable autoscale

Permintaan sampel

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Respon sampel

Kode status:

200

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.
BatchPoolEnableAutoScaleOptions	Parameter untuk mengaktifkan penskalaan otomatis pada 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.

BatchPoolEnableAutoScaleOptions

Objek

Parameter untuk mengaktifkan penskalaan otomatis pada Kumpulan Azure Batch.

Nama	Jenis	Deskripsi
autoScaleEvaluationInterval	string (duration)	Interval waktu untuk menyesuaikan ukuran Kumpulan secara otomatis sesuai dengan rumus skala otomatis. Nilai defaultnya adalah 15 menit. Nilai minimum dan maksimum masing-masing adalah 5 menit dan 168 jam. Jika Anda menentukan nilai kurang dari 5 menit atau lebih besar dari 168 jam, layanan Batch menolak permintaan dengan kesalahan nilai properti yang tidak valid; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk). Jika Anda menentukan interval baru, maka jadwal evaluasi skala otomatis yang ada akan dihentikan dan jadwal evaluasi skala otomatis baru akan dimulai, dengan waktu mulai adalah waktu ketika permintaan ini dikeluarkan.
autoScaleFormula	string	Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan. Nilai defaultnya adalah 15 menit. Nilai minimum dan maksimum masing-masing adalah 5 menit dan 168 jam. Jika Anda menentukan nilai kurang dari 5 menit atau lebih besar dari 168 jam, layanan Batch menolak permintaan dengan kesalahan nilai properti yang tidak valid; jika Anda memanggil REST API secara langsung, kode status HTTP adalah 400 (Permintaan Buruk). Jika Anda menentukan interval baru, maka jadwal evaluasi skala otomatis yang ada akan dihentikan dan jadwal evaluasi skala otomatis baru akan dimulai, dengan waktu mulai adalah waktu ketika permintaan ini dikeluarkan.