Pool - Enable Auto Scale

Lehetővé teszi a készlet automatikus skálázását.
Készleten nem engedélyezhető az automatikus skálázás, ha átméretezési művelet van folyamatban a készleten. Ha a készlet automatikus méretezése jelenleg le van tiltva, a kérés részeként meg kell adnia egy érvényes automatikus skálázási képletet. Ha a készlet automatikus méretezése már engedélyezve van, megadhat egy új automatikus skálázási képletet és/vagy egy új kiértékelési időközt. Ezt az API-t nem hívhatja meg 30 másodpercenként többször ugyanahhoz a készlethez.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/enableautoscale?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

Annak a készletnek az azonosítója, amelyen engedélyezni szeretné az automatikus skálázást.

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, olyan GUID formátumban, amely nem rendelkezik díszítéssel, például kapcsos zárójelekkel, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Azt határozza meg, hogy a kiszolgálónak vissza kell-e küldenie a válaszban szereplő client-request-id azonosítót.

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óraidőre á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ásának időpontjá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őpont óta módosult.

If-Unmodified-Since

string

date-time-rfc1123

Az ügyfél által ismert erőforrás utolsó módosításának időpontjá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őpont óta.

Kérelem törzse

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

Name Típus Description
autoScaleEvaluationInterval

string

Az az időintervallum, amikor a készlet mérete automatikusan módosítható az automatikus skálázási képletnek megfelelően.
Az alapértelmezett érték 15 perc. A minimális és maximális érték 5 perc, illetve 168 óra. Ha 5 percnél rövidebb vagy 168 óránál hosszabb értéket ad meg, a Batch szolgáltatás érvénytelen tulajdonságérték-hibával utasítja el a kérést; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés). Ha új időközt ad meg, akkor a meglévő automatikus skálázás kiértékelési ütemezése leáll, és egy új automatikus skálázási kiértékelési ütemezés lesz elindítva, amelynek kezdő időpontja a kérés kiállításának időpontja.

autoScaleFormula

string

A készletben lévő számítási csomópontok kívánt számának képlete.
A rendszer ellenőrzi a képlet érvényességét, mielőtt alkalmazva lenne a készletre. Ha a képlet érvénytelen, a Batch szolgáltatás elutasítja a kérelmet részletes hibainformációkkal. A képlet megadásával kapcsolatos további információkért lásd: Számítási csomópontok automatikus méretezése Azure Batch készletben (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Válaszok

Name Típus Description
200 OK

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 enable autoscale

Sample Request

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



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

Sample Response

Definíciók

Name Description
BatchError

Hibaválasz érkezett a Azure Batch szolgáltatástól.

BatchErrorDetail

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

ErrorMessage

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

PoolEnableAutoScaleParameter

Az automatikus skálázás készleten való engedélyezésének lehetőségei.

BatchError

Hibaválasz érkezett a Azure Batch szolgáltatástól.

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

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

Name Típus Description
key

string

Egy azonosító, amely az Érték tulajdonság jelentését adja meg.

value

string

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

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.

PoolEnableAutoScaleParameter

Az automatikus skálázás készleten való engedélyezésének lehetőségei.

Name Típus Description
autoScaleEvaluationInterval

string

Az az időintervallum, amikor a készlet mérete automatikusan módosítható az automatikus skálázási képletnek megfelelően.
Az alapértelmezett érték 15 perc. A minimális és maximális érték 5 perc, illetve 168 óra. Ha 5 percnél rövidebb vagy 168 óránál hosszabb értéket ad meg, a Batch szolgáltatás érvénytelen tulajdonságérték-hibával utasítja el a kérést; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés). Ha új időközt ad meg, akkor a meglévő automatikus skálázás kiértékelési ütemezése leáll, és egy új automatikus skálázási kiértékelési ütemezés lesz elindítva, amelynek kezdő időpontja a kérés kiállításának időpontja.

autoScaleFormula

string

A készletben lévő számítási csomópontok kívánt számának képlete.
A rendszer ellenőrzi a képlet érvényességét, mielőtt alkalmazva lenne a készletre. Ha a képlet érvénytelen, a Batch szolgáltatás elutasítja a kérelmet részletes hibainformációkkal. A képlet megadásával kapcsolatos további információkért lásd: Számítási csomópontok automatikus méretezése Azure Batch készletben (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).