Share via

Pool - Resize

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

Modifica il numero di nodi di calcolo assegnati a un pool.
È possibile ridimensionare un pool solo quando lo stato di allocazione è costante. Se il ridimensionamento del pool è già ridimensionato, la richiesta ha esito negativo con il codice di stato 409. Quando si ridimensiona un pool, lo stato di allocazione del pool cambia da costante a ridimensionamento. Non è possibile ridimensionare i pool configurati per il ridimensionamento automatico. Se si tenta di eseguire questa operazione, il servizio Batch restituisce un errore 409. Se si ridimensiona un pool verso il basso, il servizio Batch sceglie quali nodi di calcolo rimuovere. Per rimuovere nodi di calcolo specifici, usare invece l'API Nodi di calcolo rimossa dal pool.

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

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 da ridimensionare.
api-version
 query True

string

Versione dell'API client.
timeout
 query

integer

int32

Tempo massimo per cui il server può trascorrere 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à richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50E-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

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

string

date-time-rfc1123

Ora in cui è stata eseguita la richiesta. Le librerie client in genere impostano l'ora dell'orologio del sistema corrente; 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'ultima ora modificata 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'ultima ora modificata della risorsa nota al client. L'operazione verrà eseguita solo se la risorsa nel servizio non è stata modificata dopo l'ora specificata.

Corpo della richiesta

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

Nome Tipo Descrizione
nodeDeallocationOption

ComputeNodeDeallocationOption

Determina cosa fare con un nodo di calcolo e le relative attività in esecuzione se le dimensioni del pool sono diminuite.
Il valore predefinito è requeue.
resizeTimeout

string

Timeout per l'allocazione di nodi al pool o alla rimozione dei nodi di calcolo dal pool.
Il valore predefinito è 15 minuti. Il valore minimo è di 5 minuti. Se si specifica un valore minore di 5 minuti, il servizio Batch restituisce un errore; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida).
targetDedicatedNodes

integer

Numero desiderato di nodi di calcolo dedicati nel pool.
targetLowPriorityNodes

integer

Numero desiderato di nodi di calcolo con priorità spot/bassa nel pool.

Risposte

Nome Tipo Descrizione
202 Accepted

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 dal servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso di 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 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

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

Determina cosa fare con un nodo di calcolo e le relative attività in esecuzione dopo che è stata selezionata per deallocation.
ErrorMessage

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

Opzioni per la modifica delle dimensioni di 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 usati a livello di codice.
message

ErrorMessage

Messaggio che descrive l'errore, destinato a 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 all'errore.

ComputeNodeDeallocationOption

Determina cosa fare con un nodo di calcolo e le relative attività in esecuzione dopo che è stata selezionata per deallocation.

Nome Tipo Descrizione
requeue

string

Terminare l'esecuzione di processi attività e ripetere la sequenza delle attività. Le attività verranno eseguite di nuovo quando è disponibile un nodo di calcolo. Rimuovere nodi di calcolo non appena le attività sono state terminate.
retaineddata

string

Consentire il completamento delle attività in esecuzione, quindi attendere la scadenza di tutti i periodi di conservazione dei dati attività. Pianificare nessuna nuova attività durante l'attesa. Rimuovere nodi di calcolo quando sono scaduti tutti i periodi di conservazione delle attività.
taskcompletion

string

Consenti di completare le attività attualmente in esecuzione. Pianificare nessuna nuova attività durante l'attesa. Rimuovere nodi di calcolo al termine di tutte le attività.
terminate

string

Terminare l'esecuzione di attività. Le attività verranno completate con failureInfo che indica che sono state terminate e non verranno eseguiti di nuovo. Rimuovere nodi di calcolo non appena le attività sono state terminate.

ErrorMessage

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

Nome Tipo Descrizione
lang

string

Codice del linguaggio del messaggio di errore
value

string

Testo del messaggio.

PoolResizeParameter

Opzioni per la modifica delle dimensioni di un pool.

Nome Tipo Descrizione
nodeDeallocationOption

ComputeNodeDeallocationOption

Determina cosa fare con un nodo di calcolo e le relative attività in esecuzione se le dimensioni del pool sono diminuite.
Il valore predefinito è requeue.
resizeTimeout

string

Timeout per l'allocazione di nodi al pool o alla rimozione dei nodi di calcolo dal pool.
Il valore predefinito è 15 minuti. Il valore minimo è di 5 minuti. Se si specifica un valore minore di 5 minuti, il servizio Batch restituisce un errore; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida).
targetDedicatedNodes

integer

Numero desiderato di nodi di calcolo dedicati nel pool.
targetLowPriorityNodes

integer

Numero desiderato di nodi di calcolo con priorità spot/bassa nel pool.