Pool - Evaluate Auto Scale

Servicio:

Batch Service

Versión de la API:

2024-07-01.20.0

Obtiene el resultado de evaluar una fórmula de escalado automático en el grupo.
Esta API es principalmente para validar una fórmula de escalado automático, ya que simplemente devuelve el resultado sin aplicar la fórmula al grupo. El grupo debe tener habilitado el escalado automático para evaluar una fórmula.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
poolId	path	True	string	Identificador del grupo en el que se va a evaluar la fórmula de escalado automático.
api-version	query	True	string	Versión de la API de cliente.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
client-request-id		string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date		string date-time-rfc1123	Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.

Cuerpo de la solicitud

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

Nombre	Requerido	Tipo	Description
autoScaleFormula	True	string	Fórmula para el número deseado de nodos de proceso en el grupo. La fórmula se valida y sus resultados se calculan, pero no se aplica al grupo. Para aplicar la fórmula al grupo, "Habilitar el escalado automático en un grupo". Para más información sobre cómo especificar esta fórmula, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Respuestas

Nombre	Tipo	Description
200 OK	AutoScaleRun	Respuesta que contiene los resultados de la evaluación de escalabilidad automática. Encabezados client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

Flujo de código de autenticación de Microsoft Entra OAuth 2.0

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar la cuenta de usuario

Authorization

Tipo: apiKey
En: header

Ejemplos

Pool evaluate autoscale

Solicitud de ejemplo

HTTP

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



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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AutoScaleRun	Los resultados y errores de una ejecución de una fórmula de escalado automático de grupo.
AutoScaleRunError	Error que se produjo al ejecutar o evaluar una fórmula de escalado automático del grupo.
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Un elemento de información adicional incluida en una respuesta de error de Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error de Azure Batch.
NameValuePair	Representa un par nombre-valor.
PoolEvaluateAutoScaleParameter	Opciones para evaluar una fórmula de escalado automático en un grupo.

AutoScaleRun

Los resultados y errores de una ejecución de una fórmula de escalado automático de grupo.

Nombre	Tipo	Description
error	AutoScaleRunError	Detalles del error encontrado al evaluar la fórmula de escalado automático en el grupo, si la evaluación no se realizó correctamente.
results	string	Los valores finales de todas las variables usadas en la evaluación de la fórmula de escalado automático. Cada valor de variable se devuelve en el formato $variable=value y las variables se separan por punto y coma.
timestamp	string	Hora a la que se evaluó por última vez la fórmula de escalado automático.

AutoScaleRunError

Error que se produjo al ejecutar o evaluar una fórmula de escalado automático del grupo.

Nombre	Tipo	Description
code	string	Identificador del error de escalado automático. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error de escalado automático, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	NameValuePair[]	Lista de detalles de error adicionales relacionados con el error de escalado automático.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

ErrorMessage

Mensaje de error recibido en una respuesta de error de Azure Batch.

Nombre	Tipo	Description
lang	string	El código de idioma del mensaje de error
value	string	Texto del mensaje.

NameValuePair

Representa un par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre del par nombre-valor.
value	string	Valor del par nombre-valor.

PoolEvaluateAutoScaleParameter

Opciones para evaluar una fórmula de escalado automático en un grupo.

Nombre	Tipo	Description
autoScaleFormula	string	Fórmula para el número deseado de nodos de proceso en el grupo. La fórmula se valida y sus resultados se calculan, pero no se aplica al grupo. Para aplicar la fórmula al grupo, "Habilitar el escalado automático en un grupo". Para más información sobre cómo especificar esta fórmula, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).