Compartir a través de

Pools - Evaluate Pool Auto Scale

Servicio:
Batch Service
Versión de la API:
2025-06-01

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 {endpoint}/pools/{poolId}/evaluateautoscale?api-version=2025-06-01
Con parámetros opcionales: 
POST {endpoint}/pools/{poolId}/evaluateautoscale?api-version=2025-06-01&timeOut={timeOut}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string (uri)

Punto de conexión de la cuenta de Batch (por ejemplo: https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

El ID del Pool sobre el que evaluar la fórmula de escalado automático.
api-version
 query True

string

minLength: 1

La versión de API que se va a utilizar para esta operación.
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

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-rfc7231)

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 se calculan sus resultados, pero no se aplica al Pool. Para aplicar la fórmula al Pool, 'Habilitar el escalado automático en un Pool'. Para más información sobre cómo especificar esta fórmula, véase Escalar automáticamente Nodos de Cómputo en un Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

Respuestas

Nombre Tipo Description
200 OK

AutoScaleRun

La solicitud se ha realizado correctamente.

Encabezados

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

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

Ámbitos

Nombre Description
https://batch.core.windows.net//.default

Ejemplos

Pool evaluate autoscale

Solicitud de ejemplo

POST {endpoint}/pools/poolId/evaluateautoscale?api-version=2025-06-01



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

Respuesta de muestra

status code:
200 
{
  "timestamp": "2025-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.
BatchErrorMessage

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

Parámetros para evaluar una fórmula de escalado automático en un grupo de Azure Batch.
NameValuePair

Representa un par nombre-valor.

AutoScaleRun

Objeto

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 evaluando la fórmula de autoescala en el Pool, si la evaluación no tenía éxito.
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 (date-time)

Hora a la que se evaluó por última vez la fórmula de escalado automático.

AutoScaleRunError

Objeto

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

Nombre Tipo Description
code

string

Un identificador para el error de autoescalado. Los códigos son invariables y están diseñados para consumirse mediante programación.
message

string

Un mensaje que describe el error de autoescalado, destinado a ser adecuado para su visualización en una interfaz de usuario.
values

NameValuePair[]

Una lista de detalles adicionales del error relacionados con el error de autoescala.

BatchError

Objeto

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

BatchErrorMessage

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

Objeto

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.

BatchErrorMessage

Objeto

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

El texto del mensaje.

BatchPoolEvaluateAutoScaleOptions

Objeto

Parámetros para evaluar una fórmula de escalado automático en un grupo de Azure Batch.

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 se calculan sus resultados, pero no se aplica al Pool. Para aplicar la fórmula al Pool, 'Habilitar el escalado automático en un Pool'. Para más información sobre cómo especificar esta fórmula, véase Escalar automáticamente Nodos de Cómputo en un Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

NameValuePair

Objeto

Representa un par nombre-valor.

Nombre Tipo Description
name

string

El nombre en el par nombre-valor.
value

string

El valor en el par nombre-valor.