Pool - Enable Auto Scale

Service:

Batch Service

API Version:

2023-11-01.18.0

Mengaktifkan penskalaan otomatis untuk Kumpulan.
Anda tidak dapat mengaktifkan penskalakan otomatis pada Kumpulan jika operasi pengurangan 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 {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2023-11-01.18.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
batchUrl	path	True	string	URL dasar untuk semua permintaan layanan Azure Batch.
poolId	path	True	string	ID Kumpulan tempat mengaktifkan penskalaan otomatis.
api-version	query	True	string	Versi API Klien.
timeout	query		integer int32	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik.

Header Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string uuid	Identitas permintaan yang dihasilkan pemanggil, 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.
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.
If-Modified-Since		string date-time-rfc1123	Tanda waktu yang menunjukkan waktu modifikasi terakhir 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-rfc1123	Tanda waktu yang menunjukkan waktu modifikasi terakhir sumber daya yang diketahui oleh klien. Operasi akan dilakukan hanya jika sumber daya pada layanan belum dimodifikasi sejak waktu yang ditentukan.

Isi Permintaan

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

Nama	Jenis	Deskripsi
autoScaleEvaluationInterval	string	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 mulainya saat permintaan ini dikeluarkan.
autoScaleFormula	string	Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan. Rumus diperiksa validitasnya sebelum diterapkan ke Kumpulan. Jika rumus tidak valid, layanan Batch menolak permintaan dengan informasi kesalahan terperinci. Untuk informasi selengkapnya tentang menentukan rumus ini, lihat Menskalakan Simpul Komputasi secara otomatis dalam Kumpulan Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Respons

Nama	Jenis	Deskripsi
200 OK		Permintaan ke layanan Batch berhasil. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Kesalahan dari layanan Batch.

Keamanan

azure_auth

Microsoft Entra alur kode autentikasi OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Authorization

Type: apiKey
In: header

Contoh

Pool enable autoscale

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2023-11-01.18.0



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

Sample Response

Status code:

200

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
ErrorMessage	Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.
PoolEnableAutoScaleParameter	Opsi untuk mengaktifkan penskalaan otomatis pada Kumpulan.

BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah 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

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 disertakan dengan respons kesalahan.

ErrorMessage

Pesan kesalahan yang diterima dalam respons kesalahan Azure Batch.

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

PoolEnableAutoScaleParameter

Opsi untuk mengaktifkan penskalaan otomatis pada Kumpulan.

Nama	Jenis	Deskripsi
autoScaleEvaluationInterval	string	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 mulainya saat permintaan ini dikeluarkan.
autoScaleFormula	string	Rumus untuk jumlah Simpul Komputasi yang diinginkan di Kumpulan. Rumus diperiksa validitasnya sebelum diterapkan ke Kumpulan. Jika rumus tidak valid, layanan Batch menolak permintaan dengan informasi kesalahan terperinci. Untuk informasi selengkapnya tentang menentukan rumus ini, lihat Menskalakan Simpul Komputasi secara otomatis dalam Kumpulan Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).