Pool - Remove Nodes

Service:

Batch Service

API Version:

2023-11-01.18.0

Tar bort beräkningsnoder från den angivna poolen.
Den här åtgärden kan bara köras när allokeringstillståndet för poolen är stabilt. När den här åtgärden körs ändras allokeringstillståndet från stabilt till storleksändring. Varje begäran kan ta bort upp till 100 noder.

POST {batchUrl}/pools/{poolId}/removenodes?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/removenodes?timeout={timeout}&api-version=2023-11-01.18.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
poolId	path	True	string	ID:t för poolen som du vill ta bort beräkningsnoder från.
api-version	query	True	string	Klient-API-version.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt.
If-Match		string	Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten.
If-None-Match		string	Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since		string date-time-rfc1123	En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since		string date-time-rfc1123	En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden.

Begärandetext

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

Name	Obligatorisk	Typ	Description
nodeList	True	string[]	En lista som innehåller ID:t för de beräkningsnoder som ska tas bort från den angivna poolen. Högst 100 noder kan tas bort per begäran.
nodeDeallocationOption		ComputeNodeDeallocationOption	Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs när den har valts för frigöring. Standardvärdet visas på nytt.
resizeTimeout		string	Tidsgränsen för borttagning av beräkningsnoder till poolen. Standardvärdet är 15 minuter. Det minsta värdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. om du anropar REST API direkt är HTTP-statuskoden 400 (felaktig begäran).

Svar

Name	Typ	Description
202 Accepted		Begäran till Batch-tjänsten lyckades. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Pool remove nodes

Sample Request

HTTP

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

Sample Response

Status code:

202

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
ComputeNodeDeallocationOption	Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs när den har valts för frigöring.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.
NodeRemoveParameter	Alternativ för att ta bort beräkningsnoder från en pool.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ComputeNodeDeallocationOption

Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs när den har valts för frigöring.

Name	Typ	Description
requeue	string	Avsluta aktivitetsprocesser som körs och skicka aktiviteterna på nytt. Aktiviteterna körs igen när en beräkningsnod är tillgänglig. Ta bort beräkningsnoder så snart aktiviteter har avslutats.
retaineddata	string	Tillåt att aktiviteter som körs för närvarande slutförs och vänta tills alla kvarhållningsperioder för uppgiftsdata upphör att gälla. Schemalägg inga nya aktiviteter medan du väntar. Ta bort beräkningsnoder när alla kvarhållningsperioder för aktiviteter har upphört att gälla.
taskcompletion	string	Tillåt att aktiviteter som körs för närvarande slutförs. Schemalägg inga nya aktiviteter medan du väntar. Ta bort beräkningsnoder när alla aktiviteter har slutförts.
terminate	string	Avsluta aktiviteter som körs. Aktiviteterna slutförs med failureInfo som anger att de har avslutats och inte körs igen. Ta bort beräkningsnoder så snart aktiviteter har avslutats.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

NodeRemoveParameter

Alternativ för att ta bort beräkningsnoder från en pool.

Name	Typ	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Avgör vad du ska göra med en beräkningsnod och dess aktiviteter som körs när den har valts för frigöring. Standardvärdet visas på nytt.
nodeList	string[]	En lista som innehåller ID:t för de beräkningsnoder som ska tas bort från den angivna poolen. Högst 100 noder kan tas bort per begäran.
resizeTimeout	string	Tidsgränsen för borttagning av beräkningsnoder till poolen. Standardvärdet är 15 minuter. Det minsta värdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. om du anropar REST API direkt är HTTP-statuskoden 400 (felaktig begäran).