StartInstanceRefresh - Auto Scaling - Centro de documentación de Alibaba Cloud

Actualiza las instancias de un grupo de escalado cuando es necesario aplicar una nueva configuración de escalado o actualizar la imagen de las instancias del grupo de escalado.

Descripción de la operación

Un grupo de escalado puede tener solo una tarea de actualización de instancias en ejecución a la vez.
Actualmente, esta función se admite solo para grupos de escalado ECS cuya política de expansión esté configurada como Política de prioridad. Los grupos de escalado que usan Cálculo de capacidad basado en vCPU y los grupos de escalado cuyo modo de recuperación de instancias esté configurado como Modo de apagado y recuperación o Modo de apagado forzado y recuperación no admiten esta función.
Durante una actualización de instancias, se pueden realizar operaciones normales de expansión y reducción. Sin embargo, las operaciones de expansión usan la configuración deseada especificada en la tarea de actualización de instancias.
La tarea de actualización de instancias ignora las instancias que se agregan manualmente al grupo de escalado, las instancias en estado de espera y las instancias en estado protegido, y estas no participan en la actualización de instancias.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ess:StartInstanceRefresh

update

*ScalingGroup.

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región del grupo de escalado.	cn-hangzhou
ClientToken	string	No	El token de cliente que se usa para garantizar la idempotencia de la solicitud. Puede generar el token mediante el cliente, pero debe asegurarse de que sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede superar los 64 caracteres. Para obtener más información, consulte Cómo garantizar la idempotencia.	123e4567-e89b-12d3-a456-42665544****
ScalingGroupId	string	Sí	El ID del grupo de escalado.	asg-bp18p2yfxow2dloq****
MinHealthyPercentage	integer	No	El porcentaje mínimo de instancias que deben permanecer en servicio en el grupo de escalado durante la actualización de instancias. Valores válidos: 0 a 100. Valor predeterminado: 80.	80
MaxHealthyPercentage	integer	No	El porcentaje máximo en el que el número de instancias del grupo de escalado puede exceder la capacidad del grupo de escalado durante la actualización de instancias. Valores válidos: 100 a 200. Valor predeterminado: 120. Nota Si establece MinHealthyPercentage y MaxHealthyPercentage en 100, se actualiza una instancia a la vez.	100
DesiredConfiguration	object	No	La configuración deseada para la actualización de instancias. Nota No puede especificar ScalingConfigurationId, ImageId, LaunchTemplateId y Containers al mismo tiempo. Debe especificar uno de ellos. La tarea de actualización omite las instancias del grupo de escalado que ya coinciden con la configuración deseada.
ImageId	string	No	El ID de la imagen. Nota Después de que se complete la tarea de actualización de instancias, la configuración de imagen de la configuración activa del grupo de escalado se actualiza a esta imagen. Este parámetro no se admite cuando el origen de configuración de instancias del grupo de escalado es una plantilla de lanzamiento. Las imágenes que contienen discos de datos en la nube no se admiten.	m-2ze8cqacj7opnf***
ScalingConfigurationId	string	No	El ID de la configuración de escalado. Nota Después de que se complete la tarea de actualización de instancias, la configuración de escalado activa del grupo de escalado se actualiza a esta configuración.	asc-2zed7lqn4ts4****
LaunchTemplateId	string	No	El ID de la plantilla de lanzamiento. Este parámetro especifica que el grupo de escalado obtiene la información de configuración de lanzamiento de la plantilla de lanzamiento.	lt-2ze2qli30u***
LaunchTemplateVersion	string	No	La versión de la plantilla de lanzamiento. Valores válidos: Un número de versión fijo de la plantilla. Default: usa siempre la versión predeterminada de la plantilla. Latest: usa siempre la versión más reciente de la plantilla. Nota Si la versión se establece en Default o Latest, la tarea de actualización de instancias no admite rollback.	8
LaunchTemplateOverrides	array<object>	No	La información del tipo de instancia que amplía la plantilla de lanzamiento.
	object	No	La información del tipo de instancia que amplía la plantilla de lanzamiento.
InstanceType	string	No	El tipo de instancia que reemplaza el tipo de instancia especificado en la plantilla de lanzamiento.	ecs.g7.2xlarge
Containers	array<object>	No	La lista de contenedores incluidos en la instancia.
	array<object>	No	La lista de contenedores incluidos en la instancia.
Name	string	No	El nombre personalizado del contenedor.	nginx
Image	string	No	La imagen del contenedor.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	No	Los comandos de inicio del contenedor. Se admite un máximo de 20 comandos. Cada comando puede contener hasta 256 caracteres.
	string	No	El comando de inicio del contenedor. El comando puede contener hasta 256 caracteres.	sleep
Args	array	No	Los argumentos del comando de inicio del contenedor. Se admite un máximo de 10 argumentos.
	string	No	El argumento del comando de inicio del contenedor.	100
EnvironmentVars	array<object>	No	La información de las variables de entorno.
	object	No	La información de las variables de entorno.
Key	string	No	El nombre de la variable de entorno. El nombre debe tener una longitud de 1 a 128 caracteres y puede contener dígitos, letras y guiones bajos (_). No puede empezar con un dígito.	PATH
Value	string	No	El valor de la variable de entorno. El valor puede tener una longitud de 0 a 256 caracteres.	/usr/local/bin
FieldRefFieldPath	string	No	Nota Este parámetro no está disponible públicamente.	fieldPath
SkipMatching	boolean	No	Especifica si se deben omitir las instancias que coinciden con la configuración deseada. Nota El sistema determina si una instancia coincide en función del ID de la configuración de escalado deseada, no mediante la comparación de elementos de configuración específicos. Valores válidos: true: omite las instancias coincidentes. Cuando se inicia la tarea de actualización de instancias, el sistema comprueba la configuración de cada instancia. Las instancias que ya se crearon con la configuración deseada no se actualizan. false: no omite las instancias coincidentes. Después de que se inicia la tarea de actualización de instancias, se actualizan todas las instancias del grupo de escalado. Valor predeterminado: true.	true
Checkpoints	array<object>	No	Los puntos de control de la tarea de actualización. Especifica que la tarea se pausa automáticamente durante el tiempo especificado por CheckpointPauseTime cuando el porcentaje de instancias nuevas alcanza el valor especificado durante la actualización de instancias.
	object	No	Los puntos de control de la tarea de actualización. Especifica que la tarea se pausa automáticamente durante el tiempo especificado por CheckpointPauseTime cuando el porcentaje de instancias nuevas alcanza el valor especificado durante la actualización de instancias.
Percentage	integer	No	El porcentaje de instancias nuevas respecto al total de instancias del grupo de escalado. La tarea se pausa automáticamente cuando se alcanza este porcentaje. Valores válidos: 1 a 100 (%). Nota Los valores deben especificarse en orden ascendente y el último valor de porcentaje debe ser 100.	20
CheckpointPauseTime	integer	No	La duración de la pausa cuando se alcanza un punto de control de la tarea de actualización. Unidad: minutos. Valores válidos: 1 a 2880. Valor predeterminado: 60.	10
Strategy	string	No	La estrategia de ejecución de la tarea de actualización de instancias. Valores válidos: Rolling: La tarea de actualización de instancias crea instancias nuevas y libera instancias antiguas para actualizar las instancias. ReplaceSystemDisk: Actualiza el disco en la nube del sistema de las instancias existentes al especificar DesiredConfiguration.image para reemplazar el disco en la nube del sistema de las instancias. Valor predeterminado: Rolling.	Rolling

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceRefreshTaskId	string	El ID de la tarea de actualización de instancias.	ir-a12ds234fasd*****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.