Pool - Enable Auto Scale

Servicio:

Batch Service

Versión de la API:

2024-07-01.20.0

Habilita el escalado automático de un grupo.
No se puede habilitar el escalado automático en un grupo si hay una operación de cambio de tamaño en curso en el grupo. Si el escalado automático del grupo está deshabilitado actualmente, debe especificar una fórmula de escalado automático válida como parte de la solicitud. Si el escalado automático del grupo ya está habilitado, puede especificar una nueva fórmula de escalado automático o un nuevo intervalo de evaluación. No puede llamar a esta API para el mismo grupo más de una vez cada 30 segundos.

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

Con parámetros opcionales:

POST {batchUrl}/pools/{poolId}/enableautoscale?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 habilitar el 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.
If-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.
If-None-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.
If-Modified-Since		string date-time-rfc1123	Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde el momento especificado.
If-Unmodified-Since		string date-time-rfc1123	Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio no se ha modificado desde el momento especificado.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
autoScaleEvaluationInterval	string	Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es de 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especifica un nuevo intervalo, se detendrá la programación de evaluación de escalabilidad automática existente y se iniciará una nueva programación de evaluación de escalado automático, con su hora de inicio siendo la hora a la que se emitió esta solicitud.
autoScaleFormula	string	Fórmula para el número deseado de nodos de proceso en el grupo. La fórmula se comprueba si hay validez antes de aplicarla al grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. 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://azure.microsoft.com/documentation/articles/batch-automatic-scaling).

Respuestas

Nombre	Tipo	Description
200 OK		La solicitud al servicio Batch se realizó correctamente. 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 enable autoscale

Solicitud de ejemplo

HTTP

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



{
  "autoScaleFormula": "$TargetDedicated=0",
  "autoScaleEvaluationInterval": "PT8M"
}

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
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.
PoolEnableAutoScaleParameter	Opciones para habilitar el escalado automático en un grupo.

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.

PoolEnableAutoScaleParameter

Opciones para habilitar el escalado automático en un grupo.

Nombre	Tipo	Description
autoScaleEvaluationInterval	string	Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es de 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especifica un nuevo intervalo, se detendrá la programación de evaluación de escalabilidad automática existente y se iniciará una nueva programación de evaluación de escalado automático, con su hora de inicio siendo la hora a la que se emitió esta solicitud.
autoScaleFormula	string	Fórmula para el número deseado de nodos de proceso en el grupo. La fórmula se comprueba si hay validez antes de aplicarla al grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. 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://azure.microsoft.com/documentation/articles/batch-automatic-scaling).