Pool - Enable Auto Scale

  • Referens
Tjänst:
Batch Service
API-version:
2024-07-01.20.0

Aktiverar automatisk skalning för en pool.
Du kan inte aktivera automatisk skalning på en pool om en storleksändring pågår i poolen. Om automatisk skalning av poolen för närvarande är inaktiverad måste du ange en giltig autoskalningsformel som en del av begäran. Om automatisk skalning av poolen redan är aktiverad kan du ange en ny autoskalningsformel och/eller ett nytt utvärderingsintervall. Du kan inte anropa det här API:et för samma pool mer än en gång var 30:e sekund.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0
Med valfria parametrar: 
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2024-07-01.20.0

URI-parametrar

Name I Obligatorisk Typ Description
batchUrl
 path True

string

Bas-URL:en för alla Azure Batch-tjänstbegäranden.
poolId
 path True

string

ID:t för poolen där automatisk skalning ska aktiveras.
api-version
 query True

string

Klient-API-version.
timeout
 query

integer

int32

Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name Obligatorisk Typ Description
client-request-id

string

uuid

Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Om servern ska returnera klient-request-id i svaret.
ocp-date

string

date-time-rfc1123

Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.
If-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten.
If-None-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since

string

date-time-rfc1123

En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen i tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since

string

date-time-rfc1123

En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden.

Begärandetext

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

Name Typ Description
autoScaleEvaluationInterval

string

Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln.
Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall stoppas det befintliga utvärderingsschemat för autoskalning och ett nytt utvärderingsschema för autoskalning startas, med starttiden då den här begäran utfärdades.
autoScaleFormula

string

Formeln för önskat antal beräkningsnoder i poolen.
Formeln kontrolleras för giltighet innan den tillämpas på poolen. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch-pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling).

Svar

Name Typ Description
200 OK

Begäran till Batch-tjänsten lyckades.

Sidhuvuden

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

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Pool enable autoscale

Exempelbegäran

POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2024-07-01.20.0



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

Exempelsvar

Statuskod:
200

Definitioner

Name Description
BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
PoolEnableAutoScaleParameter

Alternativ för att aktivera automatisk skalning på en pool.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name Typ Description
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message

ErrorMessage

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values

BatchErrorDetail[]

En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name Typ Description
key

string

En identifierare som anger innebörden av egenskapen Value.
value

string

Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name Typ Description
lang

string

Språkkoden för felmeddelandet
value

string

Texten i meddelandet.

PoolEnableAutoScaleParameter

Alternativ för att aktivera automatisk skalning på en pool.

Name Typ Description
autoScaleEvaluationInterval

string

Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln.
Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall stoppas det befintliga utvärderingsschemat för autoskalning och ett nytt utvärderingsschema för autoskalning startas, med starttiden då den här begäran utfärdades.
autoScaleFormula

string

Formeln för önskat antal beräkningsnoder i poolen.
Formeln kontrolleras för giltighet innan den tillämpas på poolen. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch-pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling).