Condividi tramite

Pool - Evaluate Auto Scale

  • Riferimento
Servizio:
Batch Service
Versione API:
2024-07-01.20.0

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

POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2024-07-01.20.0
Con parametri facoltativi: 
POST {batchUrl}/pools/{poolId}/evaluateautoscale?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 in cui valutare la formula di ridimensionamento automatico.
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.

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 vengono 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://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Risposte

Nome Tipo Descrizione
200 OK

AutoScaleRun

Risposta contenente i risultati della valutazione della scalabilità automatica.

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 evaluate autoscale

Esempio di richiesta

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



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

Risposta di esempio

Codice di stato:
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 di Azure Batch.
ErrorMessage

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

Rappresenta una coppia nome-valore.
PoolEvaluateAutoScaleParameter

Opzioni per la valutazione di una formula di ridimensionamento automatico 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

Valori finali di tutte le variabili usate nella valutazione della formula di scalabilità automatica.
Ogni valore della variabile viene restituito nel formato $variable=value e le variabili sono separate da punti e virgola.
timestamp

string

Ora dell'ultima valutazione della 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 utilizzati a livello di codice.
message

string

Messaggio che descrive l'errore di scalabilità automatica, adatto per la visualizzazione in un'interfaccia utente.
values

NameValuePair[]

Elenco di dettagli aggiuntivi sull'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 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

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.

ErrorMessage

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.

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 automatico 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 vengono 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://learn.microsoft.com/azure/batch/batch-automatic-scaling).