Pool - Evaluate Auto Scale

Service:

Batch Service

Version d'API:

2024-07-01.20.0

Obtient le résultat de l’évaluation d’une formule de mise à l’échelle automatique sur le pool.
Cette API est principalement destinée à valider une formule de mise à l’échelle automatique, car elle retourne simplement le résultat sans appliquer la formule au pool. Le pool doit avoir la mise à l’échelle automatique activée pour évaluer une formule.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
poolId	path	True	string	ID du pool sur lequel évaluer la formule de mise à l’échelle automatique.
api-version	query	True	string	Version de l’API cliente.
timeout	query		integer int32	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place.

En-tête de la demande

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

Nom	Obligatoire	Type	Description
client-request-id		string uuid	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner l’ID 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 de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

Corps de la demande

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

Nom	Obligatoire	Type	Description
autoScaleFormula	True	string	Formule pour le nombre souhaité de nœuds de calcul dans le pool. La formule est validée et ses résultats calculés, mais elle n’est pas appliquée au pool. Pour appliquer la formule au pool, « Activer la mise à l’échelle automatique sur un pool ». Pour plus d’informations sur la spécification de cette formule, consultez « Mettre automatiquement à l’échelle des nœuds de calcul dans un pool Azure Batch » (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Réponses

Nom	Type	Description
200 OK	AutoScaleRun	Réponse contenant les résultats de l’évaluation de la mise à l’échelle automatique. En-têtes client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

Flux de code d’authentification Microsoft Entra 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 evaluate autoscale

Exemple de requête

HTTP

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



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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
AutoScaleRun	Résultats et erreurs d’une exécution d’une formule de mise à l’échelle automatique du pool.
AutoScaleRunError	Erreur qui s’est produite lors de l’exécution ou de l’évaluation d’une formule de mise à l’échelle automatique de pool.
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
NameValuePair	Représente une paire nom-valeur.
PoolEvaluateAutoScaleParameter	Options d’évaluation d’une formule de mise à l’échelle automatique sur un pool.

AutoScaleRun

Résultats et erreurs d’une exécution d’une formule de mise à l’échelle automatique du pool.

Nom	Type	Description
error	AutoScaleRunError	Détails de l’erreur rencontrée lors de l’évaluation de la formule de mise à l’échelle automatique sur le pool, si l’évaluation a échoué.
results	string	Valeurs finales de toutes les variables utilisées dans l’évaluation de la formule de mise à l’échelle automatique. Chaque valeur de variable est retournée sous la forme $variable=value, et les variables sont séparées par des points-virgules.
timestamp	string	Heure à laquelle la formule de mise à l’échelle automatique a été évaluée pour la dernière fois.

AutoScaleRunError

Erreur qui s’est produite lors de l’exécution ou de l’évaluation d’une formule de mise à l’échelle automatique de pool.

Nom	Type	Description
code	string	Identificateur de l’erreur de mise à l’échelle automatique. Les codes sont invariants et sont destinés à être consommés par programme.
message	string	Message décrivant l’erreur de mise à l’échelle automatique, destiné à être adapté à l’affichage dans une interface utilisateur.
values	NameValuePair[]	Liste des détails d’erreur supplémentaires liés à l’erreur de mise à l’échelle automatique.

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 programme.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus 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.

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.

NameValuePair

Représente une paire nom-valeur.

Nom	Type	Description
name	string	Nom de la paire nom-valeur.
value	string	Valeur de la paire nom-valeur.

PoolEvaluateAutoScaleParameter

Options d’évaluation d’une formule de mise à l’échelle automatique sur un pool.

Nom	Type	Description
autoScaleFormula	string	Formule pour le nombre souhaité de nœuds de calcul dans le pool. La formule est validée et ses résultats calculés, mais elle n’est pas appliquée au pool. Pour appliquer la formule au pool, « Activer la mise à l’échelle automatique sur un pool ». Pour plus d’informations sur la spécification de cette formule, consultez « Mettre automatiquement à l’échelle des nœuds de calcul dans un pool Azure Batch » (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).