Pool - Evaluate Auto Scale

Service:

Batch Service

API-versie:

2024-07-01.20.0

Hiermee haalt u het resultaat op van het evalueren van een formule voor automatisch schalen in de pool.
Deze API is voornamelijk bedoeld voor het valideren van een formule voor automatisch schalen, omdat het resultaat eenvoudigweg wordt geretourneerd zonder de formule toe te passen op de pool. De pool moet automatisch schalen hebben ingeschakeld om een formule te kunnen evalueren.

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

Met optionele parameters:

POST {batchUrl}/pools/{poolId}/evaluateautoscale?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 waarop de formule voor automatisch schalen moet worden geëvalueerd.
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.

Aanvraagbody

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

Name	Vereist	Type	Description
autoScaleFormula	True	string	De formule voor het gewenste aantal rekenknooppunten in de pool. De formule wordt gevalideerd en de resultaten worden berekend, maar deze wordt niet toegepast op de pool. Als u de formule wilt toepassen op de pool, schakelt u automatisch schalen in op een pool. Zie 'Rekenknooppunten automatisch schalen in een Azure Batch-pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.

Antwoorden

Name	Type	Description
200 OK	AutoScaleRun	Een antwoord met de resultaten van de evaluatie van automatische schaalaanpassing. 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 evaluate autoscale

Voorbeeldaanvraag

HTTP

POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2024-07-01.20.0



{
  "autoScaleFormula": "$TargetDedicated=1"
}

Voorbeeldrespons

Statuscode:

200

{
  "timestamp": "2016-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definities

Name	Description
AutoScaleRun	De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van pools.
AutoScaleRunError	Er is een fout opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van pools.
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.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
NameValuePair	Vertegenwoordigt een naam-waardepaar.
PoolEvaluateAutoScaleParameter	Opties voor het evalueren van een formule voor automatisch schalen in een pool.

AutoScaleRun

De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van pools.

Name	Type	Description
error	AutoScaleRunError	Details van de fout die is opgetreden bij het evalueren van de formule voor automatische schaalaanpassing in de pool, als de evaluatie mislukt is.
results	string	De uiteindelijke waarden van alle variabelen die worden gebruikt bij de evaluatie van de formule voor automatische schaalaanpassing. Elke variabelewaarde wordt geretourneerd in het formulier $variable=waarde en variabelen worden gescheiden door puntkomma's.
timestamp	string	Het tijdstip waarop de formule voor automatische schaalaanpassing voor het laatst is geëvalueerd.

AutoScaleRunError

Er is een fout opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van pools.

Name	Type	Description
code	string	Een id voor de fout bij automatisch schalen. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	string	Een bericht met een beschrijving van de fout bij automatisch schalen, bedoeld voor weergave in een gebruikersinterface.
values	NameValuePair[]	Een lijst met aanvullende foutdetails met betrekking tot de fout bij automatisch schalen.

BatchError

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

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.

ErrorMessage

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.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

Name	Type	Description
name	string	De naam in het naam-waardepaar.
value	string	De waarde in het naam-waardepaar.

PoolEvaluateAutoScaleParameter

Opties voor het evalueren van een formule voor automatisch schalen in een pool.

Name	Type	Description
autoScaleFormula	string	De formule voor het gewenste aantal rekenknooppunten in de pool. De formule wordt gevalideerd en de resultaten worden berekend, maar deze wordt niet toegepast op de pool. Als u de formule wilt toepassen op de pool, schakelt u automatisch schalen in op een pool. Zie 'Rekenknooppunten automatisch schalen in een Azure Batch-pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.