Partilhar 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 do URI

Name Em Necessário Tipo Description
endpoint
 path True

string (uri)

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

string

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

string

minLength: 1

A versão da API a utilizar 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 superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

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

Name Necessário Tipo Description
client-request-id

string

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-rfc7231)

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

Corpo do Pedido

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

Name Necessário Tipo Description
nodeList True

string[]

Uma lista contendo as IDs dos nós de computação a serem removidos do pool especificado. Um máximo de 100 nós podem ser removidos por solicitação.
nodeDeallocationOption

BatchNodeDeallocationOption

Determina o que fazer com um Nó de Computação e sua(s) tarefa(s) em execução depois de ter sido selecionado para deallocation. O valor padrão é requeue.
resizeTimeout

string (duration)

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

Respostas

Name Tipo Description
202 Accepted

O pedido foi aceite 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

Pool remove nodes

Pedido de amostra

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



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

Resposta da amostra

Código de estado:
202

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

Object

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

BatchErrorMessage

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

Object

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.

BatchErrorMessage

Object

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

Name Tipo Description
lang

string

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

string

O texto da mensagem.

BatchNodeDeallocationOption

Enumeração

BatchNodeDeallocationOption enums

Valor Description
requeue

Encerre os processos de Tarefas em execução e coloque novamente as Tarefas na fila. As Tarefas serão executadas novamente quando um Nó de Computação estiver disponível. Remova os nós de computação assim que as tarefas forem encerradas.
terminate

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

Permitir que as Tarefas atualmente em execução sejam concluídas. Não agende novas tarefas enquanto espera. Remova os nós de computação quando todas as tarefas tiverem sido concluídas.
retaineddata

Preterido, recomendamos que você carregue dados de tarefas no Armazenamento do Azure em sua tarefa e use TaskCompletion em vez disso. Permita que as Tarefas atualmente em execução sejam concluídas e, em seguida, aguarde até que todos os períodos de retenção de dados da Tarefa expirem. Não agende novas tarefas enquanto espera. Remova os nós de computação quando todos os períodos de retenção de tarefas tiverem expirado.

BatchNodeRemoveOptions

Object

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

Name Tipo Description
nodeDeallocationOption

BatchNodeDeallocationOption

Determina o que fazer com um Nó de Computação e sua(s) tarefa(s) em execução depois de ter sido selecionado para deallocation. O valor padrão é requeue.
nodeList

string[]

Uma lista contendo as IDs dos nós de computação a serem removidos do pool especificado. Um máximo de 100 nós podem ser removidos por solicitação.
resizeTimeout

string (duration)

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