Pool - Evaluate Auto Scale

Serviço:

Batch Service

Versão da API:

2023-11-01.18.0

Obtém o resultado da avaliação de uma fórmula de dimensionamento automático no Conjunto.
Esta API destina-se principalmente à validação de uma fórmula de dimensionamento automático, uma vez que simplesmente devolve o resultado sem aplicar a fórmula ao Conjunto. O Conjunto tem de ter o dimensionamento automático ativado para avaliar uma fórmula.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
poolId	path	True	string	O ID do Conjunto no qual se avalia a fórmula de dimensionamento automático.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
autoScaleFormula	True	string	A fórmula para o número pretendido de Nós de Computação no Conjunto. A fórmula é validada e os respetivos resultados calculados, mas não é aplicada ao Conjunto. Para aplicar a fórmula ao Conjunto, "Ativar o dimensionamento automático num Conjunto". Para obter mais informações sobre como especificar esta fórmula, veja Dimensionar automaticamente Nós de Computação num Conjunto de Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Respostas

Name	Tipo	Description
200 OK	AutoScaleRun	Uma resposta que contém os resultados da avaliação do dimensionamento automático. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Pool evaluate autoscale

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
AutoScaleRun	Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Conjunto.
AutoScaleRunError	Erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Conjunto.
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
NameValuePair	Representa um par nome-valor.
PoolEvaluateAutoScaleParameter	Opções para avaliar uma fórmula de dimensionamento automático num Conjunto.

AutoScaleRun

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Conjunto.

Name	Tipo	Description
error	AutoScaleRunError	Foram encontrados detalhes do erro ao avaliar a fórmula de dimensionamento automático no Conjunto, se a avaliação não tiver sido bem-sucedida.
results	string	Os valores finais de todas as variáveis utilizadas na avaliação da fórmula de dimensionamento automático. Cada valor variável é devolvido no formulário $variable=valor e as variáveis são separadas por ponto e vírgula.
timestamp	string	A hora em que a fórmula de dimensionamento automático foi avaliada pela última vez.

AutoScaleRunError

Erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Conjunto.

Name	Tipo	Description
code	string	Um identificador para o erro de dimensionamento automático. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro de dimensionamento automático, que se destina a ser adequada para ser apresentada numa interface de utilizador.
values	NameValuePair[]	Uma lista de detalhes de erro adicionais relacionados com o erro de dimensionamento automático.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Valor.
value	string	As informações adicionais incluídas na resposta do erro.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

NameValuePair

Representa um par nome-valor.

Name	Tipo	Description
name	string	O nome no par name-value.
value	string	O valor no par name-value.

PoolEvaluateAutoScaleParameter

Opções para avaliar uma fórmula de dimensionamento automático num Conjunto.

Name	Tipo	Description
autoScaleFormula	string	A fórmula para o número pretendido de Nós de Computação no Conjunto. A fórmula é validada e os respetivos resultados calculados, mas não é aplicada ao Conjunto. Para aplicar a fórmula ao Conjunto, "Ativar o dimensionamento automático num Conjunto". Para obter mais informações sobre como especificar esta fórmula, veja Dimensionar automaticamente Nós de Computação num Conjunto de Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).