Partager via

Compute Node - Disable Scheduling

  • Référence
Service:
Batch Service
API Version:
2023-11-01.18.0

Désactive la planification des tâches sur le nœud de calcul spécifié.
Vous pouvez désactiver la planification des tâches sur un nœud de calcul uniquement si son état de planification actuel est activé.

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

Paramètres URI

Nom Dans Obligatoire Type Description
batchUrl
 path True

string

URL de base pour toutes les demandes de service Azure Batch.
nodeId
 path True

string

ID du nœud de calcul sur lequel vous souhaitez désactiver la planification des tâches.
poolId
 path True

string

ID du pool qui contient le nœud de calcul.
api-version
 query True

string

Version de l’API cliente.
timeout
 query

integer

int32

Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Nom Obligatoire Type Description
client-request-id

string

uuid

Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date

string

date-time-rfc1123

Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure actuelle de l’horloge système ; définissez-la explicitement si vous appelez directement l’API REST.

Corps de la demande

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

Nom Type Description
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

Que faire avec les tâches en cours d’exécution lors de la désactivation de la planification des tâches sur le nœud de calcul.
La valeur par défaut est requeue.

Réponses

Nom Type Description
200 OK

La demande adressée au service Batch a réussi.

Headers

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

BatchError

Erreur du service Batch.

Sécurité

azure_auth

flux de code d’authentification OAuth 2.0 Microsoft Entra

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

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

Définitions

Nom Description
BatchError

Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
DisableComputeNodeSchedulingOption

Que faire avec les tâches en cours d’exécution lors de la désactivation de la planification des tâches sur le nœud de calcul.
ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.
NodeDisableSchedulingParameter

Options de désactivation de la planification sur un nœud de calcul.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message

ErrorMessage

Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
values

BatchErrorDetail[]

Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom Type Description
key

string

Identificateur spécifiant la signification de la propriété Value.
value

string

Informations supplémentaires incluses dans la réponse d’erreur.

DisableComputeNodeSchedulingOption

Que faire avec les tâches en cours d’exécution lors de la désactivation de la planification des tâches sur le nœud de calcul.

Nom Type Description
requeue

string

Arrêtez l’exécution des processus de tâche et remettez les tâches en file d’attente. Les tâches peuvent s’exécuter à nouveau sur d’autres nœuds de calcul, ou lorsque la planification des tâches est réactivé sur ce nœud de calcul. Entrez l’état hors connexion dès que les tâches ont été terminées.
taskcompletion

string

Autoriser l’exécution des tâches en cours d’exécution. Ne planifiez aucune nouvelle tâche pendant l’attente. Entrez l’état hors connexion lorsque toutes les tâches sont terminées.
terminate

string

Arrêtez l’exécution des tâches. Les tâches seront terminées avec failureInfo, indiquant qu’elles ont été arrêtées et ne s’exécuteront pas à nouveau. Entrez l’état hors connexion dès que les tâches ont été terminées.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom Type Description
lang

string

Code de langue du message d’erreur
value

string

Texte du message.

NodeDisableSchedulingParameter

Options de désactivation de la planification sur un nœud de calcul.

Nom Type Description
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

Que faire avec les tâches en cours d’exécution lors de la désactivation de la planification des tâches sur le nœud de calcul.
La valeur par défaut est requeue.