Compute Node - Disable Scheduling

  • Referencia
Service:
Batch Service
API Version:
2023-11-01.18.0

Deshabilita la programación de tareas en el nodo de ejecución especificado.
Puede deshabilitar la programación de tareas en un nodo de ejecución solo si su estado de programación actual está habilitado.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?timeout={timeout}&api-version=2023-11-01.18.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.
nodeId
 path True

string

Identificador del nodo de proceso en el que desea deshabilitar la programación de tareas.
poolId
 path True

string

Identificador del grupo que contiene el nodo 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.

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 a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Cuerpo de la solicitud

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

Nombre Tipo Description
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

Qué hacer con las tareas que se están ejecutando actualmente al deshabilitar la programación de tareas en el nodo de proceso.
El valor predeterminado es requeue.

Respuestas

Nombre Tipo Description
200 OK

La solicitud al servicio Batch se realizó correctamente.

Headers

  • 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 OAuth 2.0 Microsoft Entra

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

Scopes

Nombre Description
user_impersonation Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Node disable scheduling

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/disablescheduling?api-version=2023-11-01.18.0



{
  "nodeDisableSchedulingOption": "terminate"
}

Sample Response

Status code:
200

Definiciones

Nombre Description
BatchError

Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.
DisableComputeNodeSchedulingOption

Qué hacer con las tareas que se están ejecutando actualmente al deshabilitar la programación de tareas en el nodo de proceso.
ErrorMessage

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

Opciones para deshabilitar la programación en un nodo de proceso.

BatchError

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 contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error 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.

DisableComputeNodeSchedulingOption

Qué hacer con las tareas que se están ejecutando actualmente al deshabilitar la programación de tareas en el nodo de proceso.

Nombre Tipo Description
requeue

string

Finalice los procesos de tarea en ejecución y vuelva a poner en cola las tareas. Las tareas se pueden volver a ejecutar en otros nodos de proceso o cuando se vuelve a habilitar la programación de tareas en este nodo de ejecución. Escriba el estado sin conexión en cuanto se hayan terminado las tareas.
taskcompletion

string

Permitir que las tareas en ejecución se completen actualmente. Programe ninguna nueva tarea mientras espera. Escriba el estado sin conexión cuando se hayan completado todas las tareas.
terminate

string

Finalizar las tareas en ejecución. Las tareas se completarán con failureInfo que indica que finalizaron y no se volverán a ejecutar. Escriba el estado sin conexión en cuanto se hayan terminado las tareas.

ErrorMessage

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

Nombre Tipo Description
lang

string

Código de idioma del mensaje de error
value

string

Texto del mensaje.

NodeDisableSchedulingParameter

Opciones para deshabilitar la programación en un nodo de proceso.

Nombre Tipo Description
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

Qué hacer con las tareas que se están ejecutando actualmente al deshabilitar la programación de tareas en el nodo de proceso.
El valor predeterminado es requeue.