Pool - Remove Nodes

Servicio:

Batch Service

Versión de la API:

2024-07-01.20.0

Quita los nodos de proceso del grupo especificado.
Esta operación solo se puede ejecutar cuando el estado de asignación del grupo es estable. Cuando se ejecuta esta operación, el estado de asignación cambia de constante a cambio de tamaño. Cada solicitud puede quitar hasta 100 nodos.

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2024-07-01.20.0

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
poolId	path	True	string	Identificador del grupo del que desea quitar nodos de proceso.
api-version	query	True	string	Versión de la API de cliente.
timeout	query		integer (int32)	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
client-request-id		string (uuid)	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date		string (date-time-rfc1123)	Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.
If-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.
If-None-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.
If-Modified-Since		string (date-time-rfc1123)	Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde el momento especificado.
If-Unmodified-Since		string (date-time-rfc1123)	Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio no se ha modificado desde el momento especificado.

Cuerpo de la solicitud

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

Nombre	Requerido	Tipo	Description
nodeList	True	string[]	Lista que contiene los identificadores de los nodos de proceso que se van a quitar del grupo especificado. Se puede quitar un máximo de 100 nodos por solicitud.
nodeDeallocationOption		ComputeNodeDeallocationOption	Determina qué hacer con un nodo de proceso y sus tareas en ejecución después de que se haya seleccionado para la desasignación. El valor predeterminado es requeue.
resizeTimeout		string (duration)	Tiempo de espera para la eliminación de nodos de proceso en el grupo. El valor predeterminado es 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud al servicio Batch se realizó correctamente. Encabezados client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

Flujo de código de autenticación de Microsoft Entra OAuth 2.0

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar la cuenta de usuario

Authorization

Tipo: apiKey
En: header

Ejemplos

Pool remove nodes

Solicitud de ejemplo

HTTP

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



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

Respuesta de muestra

status code:

202

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Un elemento de información adicional incluida en una respuesta de error de Azure Batch.
ComputeNodeDeallocationOption	Determina qué hacer con un nodo de proceso y sus tareas en ejecución después de que se haya seleccionado para la desasignación.
ErrorMessage	Mensaje de error recibido en una respuesta de error de Azure Batch.
NodeRemoveParameter	Opciones para quitar nodos de proceso de un grupo.

BatchError

Object

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Object

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

ComputeNodeDeallocationOption

Enumeración

Determina qué hacer con un nodo de proceso y sus tareas en ejecución después de que se haya seleccionado para la desasignación.

Valor	Description
requeue	Finalice los procesos de tarea en ejecución y vuelva a poner en cola las tareas. Las tareas se ejecutarán de nuevo cuando haya un nodo de proceso disponible. Quite los nodos de proceso tan pronto como se hayan terminado las tareas.
retaineddata	Permita que las tareas en ejecución se completen y espere a que expiren todos los períodos de retención de datos de tareas. Programe ninguna nueva tarea mientras espera. Quite nodos de proceso cuando hayan expirado todos los períodos de retención de tareas.
taskcompletion	Permitir que las tareas en ejecución se completen actualmente. Programe ninguna nueva tarea mientras espera. Quite nodos de proceso cuando se hayan completado todas las tareas.
terminate	Finalizar las tareas en ejecución. Las tareas se completarán con failureInfo que indica que finalizaron y no se volverán a ejecutar. Quite los nodos de proceso tan pronto como se hayan terminado las tareas.

ErrorMessage

Object

Mensaje de error recibido en una respuesta de error de Azure Batch.

Nombre	Tipo	Description
lang	string	El código de idioma del mensaje de error
value	string	Texto del mensaje.

NodeRemoveParameter

Object

Opciones para quitar nodos de proceso de un grupo.

Nombre	Tipo	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Determina qué hacer con un nodo de proceso y sus tareas en ejecución después de que se haya seleccionado para la desasignación. El valor predeterminado es requeue.
nodeList	string[]	Lista que contiene los identificadores de los nodos de proceso que se van a quitar del grupo especificado. Se puede quitar un máximo de 100 nodos por solicitud.
resizeTimeout	string (duration)	Tiempo de espera para la eliminación de nodos de proceso en el grupo. El valor predeterminado es 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).