Compartilhar via

Pools - Remove Nodes

Serviço:
Batch Service
Versão da API:
2025-06-01

Remove nós de computação do pool especificado.
Essa operação só pode ser executada quando o estado de alocação do pool estiver estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento. Cada solicitação pode remover até 100 nós.

POST {endpoint}/pools/{poolId}/removenodes?api-version=2025-06-01
Com parâmetros opcionais: 
POST {endpoint}/pools/{poolId}/removenodes?api-version=2025-06-01&timeOut={timeOut}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string (uri)

Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

A ID do Pool a ser obtido.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
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 em seu lugar.".

Cabeçalho da solicitação

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

Nome Obrigatório Tipo Description
client-request-id

string

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 a ID de solicitação do cliente na resposta.
ocp-date

string (date-time-rfc7231)

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-Modified-Since

string (date-time-rfc7231)

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 horário especificado.
If-Unmodified-Since

string (date-time-rfc7231)

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

Corpo da solicitação

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

Nome Obrigatório Tipo Description
nodeList True

string[]

Uma lista que contém as IDs dos Nós de Computação a serem removidos do pool especificado. Um máximo de 100 nós pode ser removido por solicitação.
nodeDeallocationOption

BatchNodeDeallocationOption

Determina o que fazer com um Nó de Computação e suas tarefas em execução após ele ter sido selecionado para desalocação. O valor padrão é requeue.
resizeTimeout

string (duration)

O tempo limite para a remoção de nós de computação para o pool. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).

Respostas

Nome Tipo Description
202 Accepted

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

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

Escopos

Nome Description
https://batch.core.windows.net//.default

Exemplos

Pool remove nodes

Solicitação de exemplo

POST {endpoint}/pools/poolId/removenodes?api-version=2025-06-01



{
  "nodeList": [
    "tvm-1695681911_1-20161122t224741z",
    "tvm-1695681911_2-20161122t224741z"
  ]
}

Resposta de exemplo

Código de status:
202

Definições

Nome Description
BatchError

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

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

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

BatchNodeDeallocationOption enums
BatchNodeRemoveOptions

Parâmetros para remover nós de um Pool de Lotes do Azure.

BatchError

Objeto

Uma resposta de erro recebida do serviço do 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

BatchErrorMessage

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

Objeto

Um item de informações adicionais incluído em uma resposta de erro do 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.

BatchErrorMessage

Objeto

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

Nome Tipo Description
lang

string

O código de idioma da mensagem de erro.
value

string

O texto da mensagem.

BatchNodeDeallocationOption

Enumeração

BatchNodeDeallocationOption enums

Valor Description
requeue

Encerre a execução de processos de tarefa e requeue as Tarefas. As Tarefas serão executadas novamente quando um Nó de Computação estiver disponível. Remova nós de computação assim que as tarefas tiverem sido encerradas.
terminate

Encerrar a execução de tarefas. As Tarefas serão concluídas com failureInfo indicando que foram encerradas e não serão executadas novamente. Remova nós de computação assim que as tarefas tiverem sido encerradas.
taskcompletion

Permitir que tarefas em execução sejam concluídas no momento. Agendar nenhuma nova tarefa enquanto aguarda. Remova nós de computação quando todas as tarefas tiverem sido concluídas.
retaineddata

Preterido, recomendamos que você carregue os dados da tarefa no Armazenamento do Azure em sua tarefa e use-o TaskCompletion . Permita que tarefas em execução sejam concluídas no momento e aguarde até que todos os períodos de retenção de dados da tarefa expirem. Agendar nenhuma nova tarefa enquanto aguarda. Remova nós de computação quando todos os períodos de retenção da tarefa expirarem.

BatchNodeRemoveOptions

Objeto

Parâmetros para remover nós de um Pool de Lotes do Azure.

Nome Tipo Description
nodeDeallocationOption

BatchNodeDeallocationOption

Determina o que fazer com um Nó de Computação e suas tarefas em execução após ele ter sido selecionado para desalocação. O valor padrão é requeue.
nodeList

string[]

Uma lista que contém as IDs dos Nós de Computação a serem removidos do pool especificado. Um máximo de 100 nós pode ser removido por solicitação.
resizeTimeout

string (duration)

O tempo limite para a remoção de nós de computação para o pool. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).