Pool - Enable Auto Scale

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

Abilita il ridimensionamento automatico per un pool.
Non è possibile abilitare la scalabilità automatica in un pool se è in corso un'operazione di ridimensionamento nel pool. Se il ridimensionamento automatico del pool è attualmente disabilitato, è necessario specificare una formula di scalabilità automatica valida come parte della richiesta. Se il ridimensionamento automatico del pool è già abilitato, è possibile specificare una nuova formula di scalabilità automatica e/o un nuovo intervallo di valutazione. Non è possibile chiamare questa API per lo stesso pool più volte ogni 30 secondi.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
batchUrl
 path True

string

URL di base per tutte le richieste di servizio Azure Batch.
poolId
 path True

string

ID del pool in cui abilitare il ridimensionamento automatico.
api-version
 query True

string

Versione dell'API client.
timeout
 query

integer

int32

Tempo massimo per cui il server può dedicare l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

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

Nome Necessario Tipo Descrizione
client-request-id

string

uuid

Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date

string

date-time-rfc1123

Ora di emissione della richiesta. Le librerie client impostano in genere questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.
If-Match

string

Valore ETag associato alla versione della risorsa nota al client. L'operazione verrà eseguita solo se l'ETag corrente della risorsa nel servizio corrisponde esattamente al valore specificato dal client.
If-None-Match

string

Valore ETag associato alla versione della risorsa nota al client. L'operazione verrà eseguita solo se l'ETag corrente della risorsa nel servizio non corrisponde al valore specificato dal client.
If-Modified-Since

string

date-time-rfc1123

Timestamp che indica l'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio è stata modificata dall'ora specificata.
If-Unmodified-Since

string

date-time-rfc1123

Timestamp che indica l'ora dell'ultima modifica della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio non è stata modificata dall'ora specificata.

Corpo della richiesta

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

Nome Tipo Descrizione
autoScaleEvaluationInterval

string

Intervallo di tempo in base al quale regolare automaticamente le dimensioni del pool in base alla formula di scalabilità automatica.
Il valore predefinito è 15 minuti. Il valore minimo e massimo sono rispettivamente 5 minuti e 168 ore. Se si specifica un valore minore di 5 minuti o superiore a 168 ore, il servizio Batch rifiuta la richiesta con un errore di valore della proprietà non valido; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida). Se si specifica un nuovo intervallo, la pianificazione di valutazione della scalabilità automatica esistente verrà arrestata e verrà avviata una nuova pianificazione di valutazione della scalabilità automatica, con l'ora di inizio in cui è stata eseguita la richiesta.
autoScaleFormula

string

Formula per il numero desiderato di nodi di calcolo nel pool.
La formula viene verificata la validità prima che venga applicata al pool. Se la formula non è valida, il servizio Batch rifiuta la richiesta con informazioni dettagliate sull'errore. Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Risposte

Nome Tipo Descrizione
200 OK

La richiesta al servizio Batch ha avuto esito positivo.

Headers

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

BatchError

Errore del servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso del codice di autenticazione OAuth 2.0

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

Scopes

Nome Descrizione
user_impersonation Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

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

Status code:
200

Definizioni

Nome Descrizione
BatchError

Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.
PoolEnableAutoScaleParameter

Opzioni per abilitare il ridimensionamento automatico in un pool.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message

ErrorMessage

Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
values

BatchErrorDetail[]

Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome Tipo Descrizione
key

string

Identificatore che specifica il significato della proprietà Value.
value

string

Informazioni aggiuntive incluse nella risposta di errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome Tipo Descrizione
lang

string

Codice linguistico del messaggio di errore
value

string

Testo del messaggio.

PoolEnableAutoScaleParameter

Opzioni per abilitare il ridimensionamento automatico in un pool.

Nome Tipo Descrizione
autoScaleEvaluationInterval

string

Intervallo di tempo in base al quale regolare automaticamente le dimensioni del pool in base alla formula di scalabilità automatica.
Il valore predefinito è 15 minuti. Il valore minimo e massimo sono rispettivamente 5 minuti e 168 ore. Se si specifica un valore minore di 5 minuti o superiore a 168 ore, il servizio Batch rifiuta la richiesta con un errore di valore della proprietà non valido; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida). Se si specifica un nuovo intervallo, la pianificazione di valutazione della scalabilità automatica esistente verrà arrestata e verrà avviata una nuova pianificazione di valutazione della scalabilità automatica, con l'ora di inizio in cui è stata eseguita la richiesta.
autoScaleFormula

string

Formula per il numero desiderato di nodi di calcolo nel pool.
La formula viene verificata la validità prima che venga applicata al pool. Se la formula non è valida, il servizio Batch rifiuta la richiesta con informazioni dettagliate sull'errore. Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).