Partilhar via


Pool - Enable Auto Scale

Permite o dimensionamento automático para um pool.
Não é possível 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. Não é possível chamar essa API para o mesmo Pool mais de uma vez a cada 30 segundos.

POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/enableautoscale?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 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. 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.

If-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se o 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 conhecida 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 o tempo especificado.

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

Corpo do Pedido

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

Name 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 de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta). Se você especificar um novo intervalo, o cronograma de avaliação de escala automática existente será interrompido e um novo cronograma de avaliação de escala automática será iniciado, com sua hora de início sendo a hora 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 validade da fórmula é verificada antes de ser aplicada ao Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas. 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://azure.microsoft.com/documentation/articles/batch-automatic-scaling).

Respostas

Name Tipo Description
200 OK

A solicitação para o serviço de lote foi bem-sucedida.

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

Pedido de amostra

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



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

Resposta da amostra

Definições

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

PoolEnableAutoScaleParameter

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

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.

PoolEnableAutoScaleParameter

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

Name 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 de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta). Se você especificar um novo intervalo, o cronograma de avaliação de escala automática existente será interrompido e um novo cronograma de avaliação de escala automática será iniciado, com sua hora de início sendo a hora 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 validade da fórmula é verificada antes de ser aplicada ao Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas. 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://azure.microsoft.com/documentation/articles/batch-automatic-scaling).