Pool - Remove Nodes
Supprime les nœuds de calcul du pool spécifié.
Cette opération ne peut s’exécuter que lorsque l’état d’allocation du pool est stable. Lorsque cette opération s’exécute, l’état d’allocation passe de stable à redimensionnement. Chaque requête peut supprimer jusqu’à 100 nœuds.
POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
URL de base pour toutes les demandes de service Azure Batch. |
pool
|
path | True |
string |
ID du pool à partir duquel vous souhaitez supprimer des nœuds 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 d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement. |
|
If-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client. |
|
If-None-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client. |
|
If-Modified-Since |
string date-time-rfc1123 |
Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service a été modifiée depuis l’heure spécifiée. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée. |
Corps de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
nodeList | True |
string[] |
Liste contenant les ID des nœuds de calcul à supprimer du pool spécifié. |
nodeDeallocationOption |
Détermine ce qu’il faut faire avec un nœud de calcul et ses tâches en cours d’exécution une fois qu’il a été sélectionné pour la répartition. |
||
resizeTimeout |
string |
Délai d’attente pour la suppression des nœuds de calcul dans le pool. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
La demande adressée au service Batch a réussi. En-têtes
|
|
Other Status Codes |
Erreur du service Batch. |
Sécurité
azure_auth
Microsoft Entra flux de code d’authentification OAuth 2.0
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Authorization
Type:
apiKey
Dans:
header
Exemples
Pool remove nodes
Exemple de requête
POST account.region.batch.azure.com/pools/poolId/removenodes?api-version=2023-11-01.18.0
{
"nodeList": [
"tvm-1695681911_1-20161122t224741z",
"tvm-1695681911_2-20161122t224741z"
]
}
Exemple de réponse
Définitions
Nom | Description |
---|---|
Batch |
Réponse d’erreur reçue du service Azure Batch. |
Batch |
Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch. |
Compute |
Détermine ce qu’il faut faire avec un nœud de calcul et ses tâches en cours d’exécution une fois qu’il a été sélectionné pour la répartition. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Node |
Options permettant de supprimer des nœuds de calcul d’un pool. |
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 |
Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur. |
|
values |
Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur. |
BatchErrorDetail
Élément d’informations supplémentaires incluses 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. |
ComputeNodeDeallocationOption
Détermine ce qu’il faut faire avec un nœud de calcul et ses tâches en cours d’exécution une fois qu’il a été sélectionné pour la répartition.
Nom | Type | Description |
---|---|---|
requeue |
string |
Arrêtez les processus de tâche en cours d’exécution et remettez en file d’attente les tâches. Les tâches s’exécutent à nouveau lorsqu’un nœud de calcul est disponible. Supprimez les nœuds de calcul dès que les tâches ont été terminées. |
retaineddata |
string |
Autoriser l’exécution des tâches en cours d’exécution, puis attendre l’expiration de toutes les périodes de conservation des données des tâches. Ne planifiez aucune nouvelle tâche pendant l’attente. Supprimez les nœuds de calcul lorsque toutes les périodes de rétention des tâches ont expiré. |
taskcompletion |
string |
Autoriser l’exécution des tâches en cours d’exécution. Ne planifiez aucune nouvelle tâche pendant l’attente. Supprimez les nœuds de calcul une fois toutes les tâches terminées. |
terminate |
string |
Arrêtez l’exécution des tâches. Les tâches sont terminées avec failureInfo indiquant qu’elles ont été arrêtées et qu’elles ne s’exécuteront pas à nouveau. Supprimez les nœuds de calcul 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. |
NodeRemoveParameter
Options permettant de supprimer des nœuds de calcul d’un pool.
Nom | Type | Description |
---|---|---|
nodeDeallocationOption |
Détermine ce qu’il faut faire avec un nœud de calcul et ses tâches en cours d’exécution une fois qu’il a été sélectionné pour la répartition. |
|
nodeList |
string[] |
Liste contenant les ID des nœuds de calcul à supprimer du pool spécifié. |
resizeTimeout |
string |
Délai d’attente pour la suppression des nœuds de calcul dans le pool. |