Pool - Evaluate Auto Scale
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 automatische schaalaanpassing, omdat deze alleen het resultaat retourneert zonder de formule toe te passen op de pool. Voor de pool moet automatisch schalen zijn ingeschakeld om een formule te kunnen evalueren.
POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/evaluateautoscale?timeout={timeout}&api-version=2023-11-01.18.0
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
De basis-URL voor alle Azure Batch serviceaanvragen. |
pool
|
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. |
Aanvraagkoptekst
Media Types: "application/json; odata=minimalmetadata"
Name | Vereist | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
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 client-request-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 systeemkloktijd; stel dit 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. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Een antwoord met de resultaten van de evaluatie van automatische schaalaanpassing. Kopteksten
|
|
Other Status Codes |
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
POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2023-11-01.18.0
{
"autoScaleFormula": "$TargetDedicated=1"
}
Voorbeeldrespons
{
"timestamp": "2016-11-22T19:39:28.5246331Z",
"results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}
Definities
Name | Description |
---|---|
Auto |
De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen. |
Auto |
Een fout die is opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van groepen. |
Batch |
Een foutbericht dat is ontvangen van de Azure Batch-service. |
Batch |
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie. |
Error |
Een foutbericht ontvangen in een Azure Batch antwoord. |
Name |
Vertegenwoordigt een naam-waardepaar. |
Pool |
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 groepen.
Name | Type | Description |
---|---|---|
error |
Details van de fout die is opgetreden bij het evalueren van de formule voor automatische schaalaanpassing in de pool, als de evaluatie is mislukt. |
|
results |
string |
De uiteindelijke waarden van alle variabelen die worden gebruikt bij de evaluatie van de formule voor automatisch schalen. |
timestamp |
string |
Het tijdstip waarop de formule voor automatische schaalaanpassing voor het laatst is geƫvalueerd. |
AutoScaleRunError
Een fout die is opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van groepen.
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 met automatische schaalaanpassing, bedoeld om te worden weergegeven in een gebruikersinterface. |
values |
Een lijst met aanvullende foutdetails met betrekking tot de fout bij automatisch schalen. |
BatchError
Een foutbericht dat is 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 |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
|
values |
Een verzameling sleutel-waardeparen met aanvullende details 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 Value aangeeft. |
value |
string |
De aanvullende informatie die is opgenomen in de foutreactie. |
ErrorMessage
Een foutbericht ontvangen in een Azure Batch antwoord.
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. |