Pool - Evaluate Auto Scale

Service:

Batch Service

API Version:

2023-11-01.18.0

Ottiene il risultato della valutazione di una formula di ridimensionamento automatica nel pool.
Questa API è principalmente per convalidare una formula di scalabilità automatica, perché restituisce semplicemente il risultato senza applicare la formula al pool. Il pool deve avere il ridimensionamento automatico abilitato per valutare una formula.

POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?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 valutare la formula di ridimensionamento automatico.
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.

Corpo della richiesta

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

Nome	Necessario	Tipo	Descrizione
autoScaleFormula	True	string	Formula per il numero desiderato di nodi di calcolo nel pool. La formula viene convalidata e i relativi risultati calcolati, ma non vengono applicati al pool. Per applicare la formula al pool, "Abilitare il ridimensionamento automatico in un pool". 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	AutoScaleRun	Risposta contenente i risultati della valutazione della scalabilità automatica. 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 evaluate autoscale

Sample Request

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Sample Response

Status code:

200

{
  "timestamp": "2016-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definizioni

Nome	Descrizione
AutoScaleRun	Risultati ed errori da un'esecuzione di una formula di scalabilità automatica del pool.
AutoScaleRunError	Errore che si è verificato durante l'esecuzione o la valutazione di una formula di scalabilità automatica del pool.
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.
NameValuePair	Rappresenta una coppia nome/valore.
PoolEvaluateAutoScaleParameter	Opzioni per la valutazione di una formula di ridimensionamento automatica in un pool.

AutoScaleRun

Risultati ed errori da un'esecuzione di una formula di scalabilità automatica del pool.

Nome	Tipo	Descrizione
error	AutoScaleRunError	Dettagli dell'errore rilevato durante la valutazione della formula di scalabilità automatica nel pool, se la valutazione non è riuscita.
results	string	I valori finali di tutte le variabili usate nella valutazione della formula di scalabilità automatica. Ogni valore della variabile viene restituito nel modulo $variable=value e le variabili sono separate da punti e virgola.
timestamp	string	Ora in cui è stata valutata l'ultima formula di scalabilità automatica.

AutoScaleRunError

Errore che si è verificato durante l'esecuzione o la valutazione di una formula di scalabilità automatica del pool.

Nome	Tipo	Descrizione
code	string	Identificatore per l'errore di scalabilità automatica. I codici sono invarianti e devono essere usati a livello di codice.
message	string	Messaggio che descrive l'errore di scalabilità automatica, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	NameValuePair[]	Elenco di dettagli di errore aggiuntivi correlati all'errore di scalabilità automatica.

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.

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.

NameValuePair

Rappresenta una coppia nome/valore.

Nome	Tipo	Descrizione
name	string	Nome nella coppia nome-valore.
value	string	Valore nella coppia nome-valore.

PoolEvaluateAutoScaleParameter

Opzioni per la valutazione di una formula di ridimensionamento automatica in un pool.

Nome	Tipo	Descrizione
autoScaleFormula	string	Formula per il numero desiderato di nodi di calcolo nel pool. La formula viene convalidata e i relativi risultati calcolati, ma non vengono applicati al pool. Per applicare la formula al pool, "Abilitare il ridimensionamento automatico in un pool". 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).