Share via


Pool - Enable Auto Scale

Habilita o dimensionamento automático para um Pool.
Você não poderá habilitar o dimensionamento automático em um Pool se uma operação de redimensionamento estiver em andamento no Pool. Se o dimensionamento automático do Pool estiver desabilitado no momento, você deverá especificar uma fórmula de dimensionamento automático válida como parte da solicitação. Se o dimensionamento automático do Pool já estiver habilitado, você poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Você não pode chamar essa API para o mesmo pool mais de uma vez a cada 30 segundos.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/enableautoscale?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 habilitar o 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.

If-Match

string

Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.

If-None-Match

string

Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.

If-Modified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde a hora especificada.

If-Unmodified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o horário especificado.

Corpo da solicitação

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

Nome Tipo Description
autoScaleEvaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do pool de acordo com a fórmula de dimensionamento automático.
O valor padrão é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou superior a 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). Se você especificar um novo intervalo, o agendamento de avaliação de dimensionamento automático existente será interrompido e um novo agendamento de avaliação de dimensionamento automático será iniciado, sendo a hora inicial em que essa solicitação foi emitida.

autoScaleFormula

string

A fórmula para o número desejado de Nós de Computação no Pool.
A fórmula é verificada quanto à validade antes de ser aplicada ao Pool. Se a fórmula não for válida, o serviço do Lote rejeitará a solicitação com informações detalhadas de erro. 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

A solicitação para o serviço do Lote foi bem-sucedida.

Headers

  • 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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Pool enable autoscale

Sample Request

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Sample Response

Definições

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

PoolEnableAutoScaleParameter

Opções para habilitar o dimensionamento automático em um pool.

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.

PoolEnableAutoScaleParameter

Opções para habilitar o dimensionamento automático em um pool.

Nome Tipo Description
autoScaleEvaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do pool de acordo com a fórmula de dimensionamento automático.
O valor padrão é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou superior a 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). Se você especificar um novo intervalo, o agendamento de avaliação de dimensionamento automático existente será interrompido e um novo agendamento de avaliação de dimensionamento automático será iniciado, sendo a hora inicial em que essa solicitação foi emitida.

autoScaleFormula

string

A fórmula para o número desejado de Nós de Computação no Pool.
A fórmula é verificada quanto à validade antes de ser aplicada ao Pool. Se a fórmula não for válida, o serviço do Lote rejeitará a solicitação com informações detalhadas de erro. 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).