Bagikan melalui

Pool - Resize

  • Referensi
Service:
Batch Service
API Version:
2023-11-01.18.0

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 {batchUrl}/pools/{poolId}/resize?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/resize?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 yang akan diubah ukurannya.
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
nodeDeallocationOption

ComputeNodeDeallocationOption

Menentukan apa yang harus dilakukan dengan Simpul Komputasi dan tugas yang sedang berjalan jika ukuran Kumpulan menurun.
Nilai defaultnya adalah mengantri-ulang.
resizeTimeout

string

Batas waktu untuk alokasi Simpul ke Kumpulan atau penghapusan Simpul Komputasi dari Kumpulan.
Nilai defaultnya adalah 15 menit. Nilai minimumnya 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

Jumlah Simpul Komputasi khusus yang diinginkan di Kumpulan.
targetLowPriorityNodes

integer

Jumlah Simpul Komputasi Spot/Prioritas rendah yang diinginkan di Kumpulan.

Respons

Nama Jenis Deskripsi
202 Accepted

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 resize

Sample Request

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



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

Sample Response

Status code:
202

Definisi

Nama Deskripsi
BatchError

Respons kesalahan yang diterima dari layanan Azure Batch.
BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
ComputeNodeDeallocationOption

Menentukan apa yang harus dilakukan dengan Simpul Komputasi dan tugas yang sedang berjalan setelah dipilih untuk pembatalan alokasi.
ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
PoolResizeParameter

Opsi untuk mengubah ukuran 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.

ComputeNodeDeallocationOption

Menentukan apa yang harus dilakukan dengan Simpul Komputasi dan tugas yang sedang berjalan setelah dipilih untuk pembatalan alokasi.

Nama Jenis Deskripsi
requeue

string

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.
retaineddata

string

Perbolehkan Tugas yang sedang berjalan selesai, lalu tunggu hingga semua periode retensi data Tugas kedaluwarsa. Jadwalkan tidak ada Tugas baru saat menunggu. Hapus Simpul Komputasi saat semua periode retensi Tugas telah kedaluwarsa.
taskcompletion

string

Perbolehkan Tugas yang sedang berjalan selesai. Jadwalkan tidak ada Tugas baru saat menunggu. Hapus Simpul Komputasi ketika semua Tugas telah selesai.
terminate

string

Hentikan tugas yang sedang berjalan. Tugas akan diselesaikan dengan failureInfo yang menunjukkan bahwa tugas dihentikan, dan tidak akan berjalan lagi. Hapus Simpul Komputasi segera setelah Tugas dihentikan.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Nama Jenis Deskripsi
lang

string

Kode bahasa pesan kesalahan
value

string

Teks pesan.

PoolResizeParameter

Opsi untuk mengubah ukuran Kumpulan.

Nama Jenis Deskripsi
nodeDeallocationOption

ComputeNodeDeallocationOption

Menentukan apa yang harus dilakukan dengan Simpul Komputasi dan tugas yang sedang berjalan jika ukuran Kumpulan menurun.
Nilai defaultnya adalah mengantri-ulang.
resizeTimeout

string

Batas waktu untuk alokasi Simpul ke Kumpulan atau penghapusan Simpul Komputasi dari Kumpulan.
Nilai defaultnya adalah 15 menit. Nilai minimumnya 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

Jumlah Simpul Komputasi khusus yang diinginkan di Kumpulan.
targetLowPriorityNodes

integer

Jumlah Simpul Komputasi Spot/Prioritas rendah yang diinginkan di Kumpulan.