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 Pool.
Essa API destina-se principalmente à validação de uma fórmula de dimensionamento automático, pois ela simplesmente retorna o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado 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 de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
poolId	path	True	string	A ID do Pool no qual avaliar a fórmula de dimensionamento automático.
api-version	query	True	string	Versão da API do cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Corpo da solicitação

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

Nome	Obrigatório	Tipo	Description
autoScaleFormula	True	string	A fórmula para o número desejado de Nós de Computação no Pool. A fórmula é validada e seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, "Habilitar o dimensionamento automático em um pool". Para obter mais informações sobre como especificar essa fórmula, consulte Dimensionar automaticamente nós de computação em um pool de Lote do Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Respostas

Nome	Tipo	Description
200 OK	AutoScaleRun	Uma resposta que contém os resultados da avaliação de 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 do Lote.

Segurança

azure_auth

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

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Pool evaluate autoscale

Solicitação de exemplo

HTTP

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



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

Resposta de exemplo

Código de status:

200

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

Definições

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

AutoScaleRun

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

Nome	Tipo	Description
error	AutoScaleRunError	Detalhes do erro encontrado avaliando a fórmula de dimensionamento automático no Pool, se a avaliação não tiver sido bem-sucedida.
results	string	Os valores finais de todas as variáveis usadas na avaliação da fórmula de dimensionamento automático. Cada valor de variável é retornado no formulário $variable=value 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

Um erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.

Nome	Tipo	Description
code	string	Um identificador para o erro de dimensionamento automático. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro de dimensionamento automático, destinada a ser adequada para exibição em uma interface do usuário.
values	NameValuePair[]	Uma lista de detalhes de erro adicionais relacionados ao erro de dimensionamento automático.

BatchError

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.

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

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.

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

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

PoolEvaluateAutoScaleParameter

Opções para avaliar uma fórmula de dimensionamento automático em um Pool.

Nome	Tipo	Description
autoScaleFormula	string	A fórmula para o número desejado de Nós de Computação no Pool. A fórmula é validada e seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, "Habilitar o dimensionamento automático em um pool". Para obter mais informações sobre como especificar essa fórmula, consulte Dimensionar automaticamente nós de computação em um pool de Lote do Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).