Pool - Resize

Servizio:

Batch Service

Versione API:

2024-07-01.20.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à in corso, la richiesta ha esito negativo con codice di stato 409. Quando si ridimensiona un pool, lo stato di allocazione del pool passa dal ridimensionamento costante al 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 i nodi di calcolo da rimuovere. Per rimuovere nodi di calcolo specifici, usare invece l'API Nodi di calcolo per rimuovere i nodi di calcolo.

POST {batchUrl}/pools/{poolId}/resize?api-version=2024-07-01.20.0

Con parametri facoltativi:

POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2024-07-01.20.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del 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 di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

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 in genere impostano 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
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina le operazioni da eseguire con un nodo di calcolo e le relative attività in esecuzione se le dimensioni del pool diminuiscono. Il valore predefinito è requeue.
resizeTimeout	string (duration)	Timeout per l'allocazione di nodi al pool o rimozione dei nodi di calcolo dal pool. Il valore predefinito è 15 minuti. Il valore minimo è 5 minuti. Se si specifica un valore inferiore a 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 (int32)	Numero desiderato di nodi di calcolo dedicati nel pool.
targetLowPriorityNodes	integer (int32)	Numero desiderato di nodi di calcolo spot/con priorità bassa nel pool.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta al servizio Batch ha avuto esito positivo. Intestazioni 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

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Pool resize

Esempio di richiesta

HTTP

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



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Risposta di esempio

Codice di stato:

202

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
ComputeNodeDeallocationOption	Determina le operazioni da eseguire con un nodo di calcolo e le relative attività in esecuzione dopo che è stata selezionata per la deallocazione.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
PoolResizeParameter	Opzioni per la modifica delle dimensioni di un pool.

BatchError

Object

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, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Object

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

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

ComputeNodeDeallocationOption

Enumerazione

Determina le operazioni da eseguire con un nodo di calcolo e le relative attività in esecuzione dopo che è stata selezionata per la deallocazione.

Valore	Descrizione
requeue	Terminare l'esecuzione dei processi attività e rieseguere la coda delle attività. Le attività verranno eseguite di nuovo quando è disponibile un nodo di calcolo. Rimuovere i nodi di calcolo non appena le attività sono state terminate.
retaineddata	Consenti il completamento delle attività attualmente in esecuzione, quindi attendi la scadenza di tutti i periodi di conservazione dei dati attività. Non pianificare nuove attività durante l'attesa. Rimuovere i nodi di calcolo quando tutti i periodi di conservazione delle attività sono scaduti.
taskcompletion	Consenti il completamento delle attività attualmente in esecuzione. Non pianificare nuove attività durante l'attesa. Rimuovere i nodi di calcolo al termine di tutte le attività.
terminate	Terminare l'esecuzione di attività. Le attività verranno completate con failureInfo che indica che sono state terminate e non verranno eseguite di nuovo. Rimuovere i nodi di calcolo non appena le attività sono state terminate.

ErrorMessage

Object

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

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.

PoolResizeParameter

Object

Opzioni per la modifica delle dimensioni di un pool.

Nome	Tipo	Descrizione
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina le operazioni da eseguire con un nodo di calcolo e le relative attività in esecuzione se le dimensioni del pool diminuiscono. Il valore predefinito è requeue.
resizeTimeout	string (duration)	Timeout per l'allocazione di nodi al pool o rimozione dei nodi di calcolo dal pool. Il valore predefinito è 15 minuti. Il valore minimo è 5 minuti. Se si specifica un valore inferiore a 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 (int32)	Numero desiderato di nodi di calcolo dedicati nel pool.
targetLowPriorityNodes	integer (int32)	Numero desiderato di nodi di calcolo spot/con priorità bassa nel pool.