Pools - Evaluate Pool Auto Scale

Layanan:

Batch Service

Versi API:

2025-06-01

Mendapatkan hasil evaluasi rumus penskalaan otomatis pada Kumpulan.
API ini terutama untuk memvalidasi rumus skala otomatis, karena hanya mengembalikan hasil tanpa menerapkan rumus ke Kumpulan. Kumpulan harus mengaktifkan penskalaan otomatis untuk mengevaluasi rumus.

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

Dengan parameter opsional:

POST {endpoint}/pools/{poolId}/evaluateautoscale?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 untuk mengevaluasi rumus penskalaan otomatis.
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.

Isi Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
autoScaleFormula	True	string	Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan. Rumus divalidasi dan hasilnya dihitung, tetapi tidak diterapkan ke Pool. Untuk menerapkan rumus ke Kumpulan, "Aktifkan penskalaan otomatis pada Kumpulan". Untuk informasi selengkapnya tentang menentukan rumus ini, lihat Menskalakan Node Komputasi secara otomatis di Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Respons

Nama	Jenis	Deskripsi
200 OK	AutoScaleRun	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 evaluate autoscale

Permintaan sampel

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Respon sampel

Kode status:

200

{
  "timestamp": "2025-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definisi

Nama	Deskripsi
AutoScaleRun	Hasil dan kesalahan dari eksekusi rumus skala otomatis Kumpulan.
AutoScaleRunError	Kesalahan yang terjadi saat mengeksekusi atau mengevaluasi rumus skala otomatis Kumpulan.
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.
BatchPoolEvaluateAutoScaleOptions	Parameter untuk mengevaluasi rumus penskalaan otomatis pada Kumpulan Azure Batch.
NameValuePair	Mewakili pasangan nama-nilai.

AutoScaleRun

Objek

Hasil dan kesalahan dari eksekusi rumus skala otomatis Kumpulan.

Nama	Jenis	Deskripsi
error	AutoScaleRunError	Detail kesalahan yang ditemui mengevaluasi rumus skala otomatis pada Kumpulan, jika evaluasi tidak berhasil.
results	string	Nilai akhir dari semua variabel yang digunakan dalam evaluasi rumus skala otomatis. Setiap nilai variabel dikembalikan dalam formulir $variable=value, dan variabel dipisahkan oleh titik koma.
timestamp	string (date-time)	Waktu di mana rumus skala otomatis terakhir dievaluasi.

AutoScaleRunError

Objek

Kesalahan yang terjadi saat mengeksekusi atau mengevaluasi rumus skala otomatis Kumpulan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan skala otomatis. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	string	Pesan yang menjelaskan kesalahan skala otomatis, yang dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	NameValuePair[]	Daftar detail kesalahan tambahan yang terkait dengan kesalahan skala otomatis.

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.

BatchPoolEvaluateAutoScaleOptions

Objek

Parameter untuk mengevaluasi rumus penskalaan otomatis pada Kumpulan Azure Batch.

Nama	Jenis	Deskripsi
autoScaleFormula	string	Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan. Rumus divalidasi dan hasilnya dihitung, tetapi tidak diterapkan ke Pool. Untuk menerapkan rumus ke Kumpulan, "Aktifkan penskalaan otomatis pada Kumpulan". Untuk informasi selengkapnya tentang menentukan rumus ini, lihat Menskalakan Node Komputasi secara otomatis di Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

NameValuePair

Objek

Mewakili pasangan nama-nilai.

Nama	Jenis	Deskripsi
name	string	Nama dalam pasangan nama-nilai.
value	string	Nilai dalam pasangan nama-nilai.