Pool - Evaluate Auto Scale

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

Obtém o resultado da avaliação de uma fórmula de dimensionamento automático no Pool.
Esta API destina-se principalmente a validar uma fórmula de escala automática, uma vez que simplesmente devolve 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=2024-07-01.20.0

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do 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. Se o valor for maior que 30, o padrão será usado.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, 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 o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando 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 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, 'Ativar 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 lotes do Azure' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Respostas

Name	Tipo	Description
200 OK	AutoScaleRun	Uma resposta contendo os resultados da avaliação em escala automática. 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 de lote.

Segurança

azure_auth

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

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

Âmbitos

Name	Description
user_impersonation	Personificar 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=2024-07-01.20.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 escala automática de Pool.
AutoScaleRunError	Um erro que ocorreu ao executar ou avaliar uma fórmula de escala automática de pool.
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do 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 escala automática de Pool.

Name	Tipo	Description
error	AutoScaleRunError	Detalhes do erro encontrado ao avaliar a fórmula de escala automática no Pool, 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 autoescala. Cada valor de variável é retornado na forma $variable=valor, e as variáveis são separadas por ponto-e-vírgula.
timestamp	string	O momento em que a fórmula em escala automática foi avaliada pela última vez.

AutoScaleRunError

Um erro que ocorreu ao executar ou avaliar uma fórmula de escala automática de pool.

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 descrevendo o erro de dimensionamento automático, destinado a ser adequado 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 Batch do Azure.

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 descrevendo 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 do Lote do Azure.

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

ErrorMessage

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

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

Name	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, 'Ativar 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 lotes do Azure' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).