Pool - Resize

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

Módosítja a készlethez rendelt számítási csomópontok számát.
A készletet csak akkor méretezheti át, ha annak foglalási állapota állandó. Ha a készlet már átméreteződött, a kérés a 409-es állapotkóddal meghiúsul. Amikor átméretez egy készletet, a készlet foglalási állapota állandóról átméretezésre változik. Az automatikus skálázáshoz konfigurált készletek nem méretezhetők át. Ha megpróbálja ezt megtenni, a Batch szolgáltatás a 409-edik hibát adja vissza. Ha lefelé átméretez egy készletet, a Batch szolgáltatás kiválasztja az eltávolítani kívánt számítási csomópontokat. Adott számítási csomópontok eltávolításához használja inkább a Készlet eltávolítja a Számítási csomópontok API-t.

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

URI-paraméterek

Name In Kötelező Típus Description
batchUrl
 path True

string

Az összes Azure Batch szolgáltatáskérés alap URL-címe.
poolId
 path True

string

Az átméretezni kívánt készlet azonosítója.
api-version
 query True

string

Ügyfél API-verziója.
timeout
 query

integer

int32

A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name Kötelező Típus Description
client-request-id

string

uuid

A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date

string

date-time-rfc1123

A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.
If-Match

string

Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban pontosan megegyezik az ügyfél által megadott értékkel.
If-None-Match

string

Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban nem egyezik meg az ügyfél által megadott értékkel.
If-Modified-Since

string

date-time-rfc1123

Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás a megadott idő óta módosult.
If-Unmodified-Since

string

date-time-rfc1123

Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás nem módosult a megadott idő óta.

Kérelem törzse

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

Name Típus Description
nodeDeallocationOption

ComputeNodeDeallocationOption

Meghatározza, hogy mi a teendő egy számítási csomóponttal és annak futó tevékenységeivel, ha a készlet mérete csökken.
Az alapértelmezett érték az újra lekérdezés.
resizeTimeout

string

A csomópontok készletbe foglalásának vagy a számítási csomópontok készletből való eltávolításának időtúllépése.
Az alapértelmezett érték 15 perc. A minimális érték 5 perc. Ha 5 percnél rövidebb értéket ad meg, a Batch szolgáltatás hibát ad vissza; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés).
targetDedicatedNodes

integer

A készletben található dedikált számítási csomópontok kívánt száma.
targetLowPriorityNodes

integer

A készletben található kihasználatlan/alacsony prioritású számítási csomópontok kívánt száma.

Válaszok

Name Típus Description
202 Accepted

A Batch szolgáltatásnak küldött kérés sikeres volt.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name Description
user_impersonation A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

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

Definíciók

Name Description
BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.
ComputeNodeDeallocationOption

Meghatározza, hogy mi a teendő egy számítási csomóponttal és annak futó feladatával, miután kiválasztotta a felszabadításra.
ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.
PoolResizeParameter

A készlet méretének módosítására szolgáló beállítások.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name Típus Description
code

string

A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message

ErrorMessage

A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values

BatchErrorDetail[]

Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name Típus Description
key

string

Az Érték tulajdonság jelentését meghatározó azonosító.
value

string

A hibaválaszban szereplő további információk.

ComputeNodeDeallocationOption

Meghatározza, hogy mi a teendő egy számítási csomóponttal és annak futó feladatával, miután kiválasztotta a felszabadításra.

Name Típus Description
requeue

string

Állítsa le a futó tevékenységfolyamatokat, és állítsa le újra a Feladatokat. A Feladatok újra futni fog, ha egy számítási csomópont elérhető. A feladatok leállása után távolítsa el a számítási csomópontokat.
retaineddata

string

Hagyja, hogy az aktuálisan futó feladatok befejeződjenek, majd várja meg, amíg az összes tevékenységadat-megőrzési időszak lejár. Várakozás közben ne ütemezzen új feladatokat. Távolítsa el a számítási csomópontokat, ha az összes tevékenységmegőrzési időszak lejárt.
taskcompletion

string

A feladatok futtatásának engedélyezése. Várakozás közben ne ütemezzen új feladatokat. Távolítsa el a számítási csomópontokat, ha az összes tevékenység befejeződött.
terminate

string

Állítsa le a futó feladatokat. A feladatok a failureInfo hibával fejeződnek be, jelezve, hogy leálltak, és nem futnak újra. A feladatok leállása után távolítsa el a számítási csomópontokat.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name Típus Description
lang

string

A hibaüzenet nyelvkódja
value

string

Az üzenet szövege.

PoolResizeParameter

A készlet méretének módosítására szolgáló beállítások.

Name Típus Description
nodeDeallocationOption

ComputeNodeDeallocationOption

Meghatározza, hogy mi a teendő egy számítási csomóponttal és annak futó tevékenységeivel, ha a készlet mérete csökken.
Az alapértelmezett érték az újra lekérdezés.
resizeTimeout

string

A csomópontok készletbe foglalásának vagy a számítási csomópontok készletből való eltávolításának időtúllépése.
Az alapértelmezett érték 15 perc. A minimális érték 5 perc. Ha 5 percnél rövidebb értéket ad meg, a Batch szolgáltatás hibát ad vissza; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés).
targetDedicatedNodes

integer

A készletben található dedikált számítási csomópontok kívánt száma.
targetLowPriorityNodes

integer

A készletben található kihasználatlan/alacsony prioritású számítási csomópontok kívánt száma.