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

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

Descripción de la operación

Solo se puede ejecutar un nodo de actualización de instancias a la vez en un grupo de escalado.
Esta función solo admite grupos de escalado de ECS cuya política de escalado horizontal esté configurada como Política de prioridad. Los grupos de escalado que utilizan Cálculo de capacidad basado en vCPU y los grupos de escalado cuyo patrón de revocación de instancias está configurado como Patrón de apagado y revocación o Patrón de apagado forzado y revocación no admiten esta función.
Durante una actualización de instancias, se pueden realizar operaciones normales de escalado horizontal y reducción horizontal. Sin embargo, las operaciones de escalado horizontal utilizan la configuración deseada de la actualización de instancias.
Las instancias agregadas manualmente al grupo de escalado, las instancias en estado de espera y las instancias con estado de protección son ignoradas por el nodo de actualización de instancias y 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
ScalingGroupId	string	Sí	El ID del grupo de escalado.	asg-bp18p2yfxow2dloq****
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede exceder los 64 caracteres de longitud. Para obtener más información, consulte Cómo garantizar la idempotencia.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	Sí	El ID de región del grupo de escalado.	cn-hangzhou
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: de 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: de 100 a 200. Valor predeterminado: 120. Nota Cuando MinHealthyPercentage = MaxHealthyPercentage = 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. Si este parámetro se deja vacío, se utiliza la configuración activa actual del grupo de escalado para la actualización. Una vez completada la tarea de actualización de instancias, la configuración de escalado activa del grupo de escalado se actualiza a esta configuración.
ImageId	string	No	El ID de la imagen. Nota Una vez completada la tarea de actualización de instancias, la imagen en la configuración activa actual 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. No se admiten imágenes que contienen discos en la nube de datos.	m-2ze8cqacj7opnf***
ScalingConfigurationId	string	No	El ID de la configuración de escalado.	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 de plantilla fijo. Default: siempre utiliza la versión predeterminada de la plantilla. Latest: siempre utiliza la versión más reciente de la plantilla. Nota No se admite la reversión para tareas de actualización de instancias cuando la versión está configurada como Default o Latest.	8
LaunchTemplateOverrides	array<object>	No	La información del tipo de instancia que extiende la plantilla de lanzamiento.
	object	No	La información del tipo de instancia que extiende la plantilla de lanzamiento.
InstanceType	string	No	El tipo de instancia que reemplaza al tipo de instancia especificado en la plantilla de lanzamiento. Nota Este parámetro solo surte efecto cuando el parámetro LaunchTemplateId especifica una plantilla de lanzamiento.	ecs.c5.2xlarge
Containers	array<object>	No	La lista de contenedores en la instancia. Nota Este parámetro solo se admite para grupos de escalado de Elastic Container Instance (ECI). Solo se actualizan las configuraciones de contenedor cuyos nombres coinciden con `Container.Name` en la lista de contenedores de la configuración de escalado actual.
	array<object>	No	La lista de contenedores 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 admiten un máximo de 20 comandos. Cada comando puede contener hasta 256 caracteres.
	string	No	Los comandos de inicio del contenedor. Se admiten un máximo de 20 comandos. Cada comando puede contener hasta 256 caracteres.	sleep
Args	array	No	Los argumentos para el comando de inicio del contenedor. Se admiten un máximo de 10 argumentos.
	string	No	Los argumentos para el comando de inicio del contenedor. Se admiten un máximo de 10 argumentos.	100
EnvironmentVars	array<object>	No	La información de variables de entorno.
	object	No	La información de 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 comenzar 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 basándose en el ID de la configuración de escalado deseada, no comparando elementos de configuración individuales. Valores válidos: true: Se omiten las instancias que ya se crearon con la configuración deseada. false: Se actualizan todas las instancias del grupo de escalado en el momento en que comienza la tarea de actualización. Valor predeterminado: true.	true
Checkpoints	array<object>	No	Los puntos de control para la tarea de actualización. Especifica que la tarea se pausa automáticamente durante CheckpointPauseTime minutos cuando el porcentaje de nuevas instancias alcanza el valor especificado durante la actualización de instancias.
	object	No	Los puntos de control para la tarea de actualización. Especifica que la tarea se pausa automáticamente durante `CheckpointPauseTime` minutos cuando el porcentaje de nuevas instancias alcanza el valor especificado durante la actualización de instancias.
Percentage	integer	No	El porcentaje de nuevas instancias respecto al total de instancias en el grupo de escalado en el cual la tarea se pausa automáticamente. Valores válidos: de 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 durante la cual se pausa la tarea cuando se alcanza un punto de control. Unidad: minutos. Valores válidos: de 1 a 2880. Valor predeterminado: 60.	10
Strategy	string	No	La estrategia de ejecución para la tarea de actualización de instancias. Valores válidos: Rolling: La tarea de actualización de instancias crea nuevas instancias y libera las antiguas para actualizar las instancias. ReplaceSystemDisk: El disco en la nube del sistema de las instancias existentes se reemplaza especificando DesiredConfiguration.image para actualizar el disco en la nube del sistema. 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.