Pool - Remove Nodes

Service:

Batch Service

API-versie:

2024-07-01.20.0

Hiermee verwijdert u rekenknooppunten uit de opgegeven pool.
Deze bewerking kan alleen worden uitgevoerd wanneer de toewijzingsstatus van de pool stabiel is. Wanneer deze bewerking wordt uitgevoerd, verandert de toewijzingsstatus van constant in het wijzigen van de grootte. Elke aanvraag kan maximaal 100 knooppunten verwijderen.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch-serviceaanvragen.
poolId	path	True	string	De id van de pool waaruit u rekenknooppunten wilt verwijderen.
api-version	query	True	string	Client-API-versie.
timeout	query		integer (int32)	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string (uuid)	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date		string (date-time-rfc1123)	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.
If-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client.
If-None-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client.
If-Modified-Since		string (date-time-rfc1123)	Een tijdstempel die de laatst gewijzigde tijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service is gewijzigd sinds de opgegeven tijd.
If-Unmodified-Since		string (date-time-rfc1123)	Een tijdstempel die de laatst gewijzigde tijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service niet is gewijzigd sinds de opgegeven tijd.

Aanvraagbody

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

Name	Vereist	Type	Description
nodeList	True	string[]	Een lijst met de id's van de rekenknooppunten die uit de opgegeven pool moeten worden verwijderd. Per aanvraag kunnen maximaal 100 knooppunten worden verwijderd.
nodeDeallocationOption		ComputeNodeDeallocationOption	Bepaalt wat u moet doen met een rekenknooppunt en de bijbehorende actieve taak(en) nadat het is geselecteerd voor de toewijzing van de deal. De standaardwaarde wordt opnieuw weergegeven.
resizeTimeout		string (duration)	De time-out voor het verwijderen van rekenknooppunten naar de pool. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde opgeeft die minder dan 5 minuten is, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag voor de Batch-service is geslaagd. Kopteksten client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Pool remove nodes

Voorbeeldaanvraag

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"
  ]
}

Voorbeeldrespons

Statuscode:

202

Definities

Name	Description
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ComputeNodeDeallocationOption	Bepaalt wat u moet doen met een rekenknooppunt en de bijbehorende actieve taak(en) nadat het is geselecteerd voor de toewijzing van de deal.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
NodeRemoveParameter	Opties voor het verwijderen van rekenknooppunten uit een pool.

BatchError

Object

Er is een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Object

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

ComputeNodeDeallocationOption

Inventarisatie

Bepaalt wat u moet doen met een rekenknooppunt en de bijbehorende actieve taak(en) nadat het is geselecteerd voor de toewijzing van de deal.

Waarde	Description
requeue	Beëindig actieve taakprocessen en volg de taken opnieuw. De taken worden opnieuw uitgevoerd wanneer er een rekenknooppunt beschikbaar is. Verwijder rekenknooppunten zodra taken zijn beëindigd.
retaineddata	Sta toe dat actieve taken zijn voltooid en wacht totdat alle retentieperioden voor taakgegevens verlopen. Plan geen nieuwe taken tijdens het wachten. Verwijder rekenknooppunten wanneer alle retentieperioden voor taken zijn verlopen.
taskcompletion	Sta toe dat taken die momenteel worden uitgevoerd, worden voltooid. Plan geen nieuwe taken tijdens het wachten. Verwijder rekenknooppunten wanneer alle taken zijn voltooid.
terminate	Beëindig de uitvoering van taken. De taken worden voltooid met failureInfo die aangeeft dat ze zijn beëindigd en worden niet opnieuw uitgevoerd. Verwijder rekenknooppunten zodra taken zijn beëindigd.

ErrorMessage

Object

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

NodeRemoveParameter

Object

Opties voor het verwijderen van rekenknooppunten uit een pool.

Name	Type	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Bepaalt wat u moet doen met een rekenknooppunt en de bijbehorende actieve taak(en) nadat het is geselecteerd voor de toewijzing van de deal. De standaardwaarde wordt opnieuw weergegeven.
nodeList	string[]	Een lijst met de id's van de rekenknooppunten die uit de opgegeven pool moeten worden verwijderd. Per aanvraag kunnen maximaal 100 knooppunten worden verwijderd.
resizeTimeout	string (duration)	De time-out voor het verwijderen van rekenknooppunten naar de pool. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde opgeeft die minder dan 5 minuten is, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).