StartInstanceRefresh - Auto Scaling - Centre de documentation Alibaba Cloud

Actualise les instances d'un groupe de mise à l'échelle lorsque vous devez appliquer une nouvelle configuration de mise à l'échelle ou mettre à jour l'image des instances du groupe de mise à l'échelle.

Description de l'opération

Un groupe de mise à l'échelle ne peut avoir qu'une seule tâche d'actualisation des instances en cours d'exécution à la fois.
Actuellement, cette fonctionnalité n'est prise en charge que pour les groupes de mise à l'échelle ECS dont la stratégie d'extension est définie sur Stratégie de priorité. Les groupes de mise à l'échelle qui utilisent le Calcul de capacité basé sur les vCPU et les groupes de mise à l'échelle dont le mode de récupération des instances est défini sur Mode d'arrêt et de récupération ou Mode d'arrêt forcé et de récupération ne prennent pas en charge cette fonctionnalité.
Pendant une actualisation des instances, les opérations normales d'extension et de réduction peuvent être effectuées. Cependant, les opérations d'extension utilisent la configuration souhaitée spécifiée dans la tâche d'actualisation des instances.
Les instances ajoutées manuellement au groupe de mise à l'échelle, les instances en état de veille et les instances en état protégé sont ignorées par la tâche d'actualisation des instances et ne participent pas à l'actualisation des instances.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ess:StartInstanceRefresh

update

*Groupe de mise à l'échelle.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du groupe de mise à l'échelle.	cn-hangzhou
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer qu'il est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et sa longueur ne peut pas dépasser 64 caractères. Pour plus d'informations, consultez Comment garantir l'idempotence.	123e4567-e89b-12d3-a456-42665544****
ScalingGroupId	string	Oui	L'identifiant du groupe de mise à l'échelle.	asg-bp18p2yfxow2dloq****
MinHealthyPercentage	integer	Non	Le pourcentage minimum d'instances qui doivent rester en service dans le groupe de mise à l'échelle pendant l'actualisation des instances. Valeurs valides : 0 à 100. Valeur par défaut : 80.	80
MaxHealthyPercentage	integer	Non	Le pourcentage maximum selon lequel le nombre d'instances dans le groupe de mise à l'échelle peut dépasser la capacité du groupe de mise à l'échelle pendant l'actualisation des instances. Valeurs valides : 100 à 200. Valeur par défaut : 120. Remarque Si vous définissez MinHealthyPercentage et MaxHealthyPercentage sur 100, une instance est actualisée à la fois.	100
DesiredConfiguration	object	Non	La configuration souhaitée pour l'actualisation des instances. Remarque Vous ne pouvez pas spécifier ScalingConfigurationId, ImageId, LaunchTemplateId et Containers en même temps. Vous devez en spécifier un. La tâche d'actualisation ignore les instances du groupe de mise à l'échelle qui correspondent déjà à la configuration souhaitée.
ImageId	string	Non	L'identifiant de l'image. Remarque Une fois la tâche d'actualisation des instances terminée, la configuration de l'image dans la configuration active du groupe de mise à l'échelle est mise à jour vers cette image. Ce paramètre n'est pas pris en charge lorsque la source de configuration des instances du groupe de mise à l'échelle est un modèle de lancement. Les images contenant des disques cloud de données ne sont pas prises en charge.	m-2ze8cqacj7opnf***
ScalingConfigurationId	string	Non	L'identifiant de la configuration de mise à l'échelle. Remarque Une fois la tâche d'actualisation des instances terminée, la configuration de mise à l'échelle active du groupe de mise à l'échelle est mise à jour vers cette configuration.	asc-2zed7lqn4ts4****
LaunchTemplateId	string	Non	L'identifiant du modèle de lancement. Ce paramètre spécifie que le groupe de mise à l'échelle obtient les informations de configuration de lancement à partir du modèle de lancement.	lt-2ze2qli30u***
LaunchTemplateVersion	string	Non	La version du modèle de lancement. Valeurs valides : Un numéro de version de modèle fixe. Default : utilise toujours la version de modèle par défaut. Latest : utilise toujours la dernière version de modèle. Remarque Si la version est définie sur Default ou Latest, la tâche d'actualisation des instances ne prend pas en charge la restauration.	8
LaunchTemplateOverrides	array<object>	Non	Les informations sur le type d'instance qui étendent le modèle de lancement.
	object	Non	Les informations sur le type d'instance qui étendent le modèle de lancement.
InstanceType	string	Non	Le type d'instance qui remplace le type d'instance spécifié dans le modèle de lancement.	ecs.g7.2xlarge
Containers	array<object>	Non	La liste des conteneurs inclus dans l'instance.
	array<object>	Non	La liste des conteneurs inclus dans l'instance.
Name	string	Non	Le nom personnalisé du conteneur.	nginx
Image	string	Non	L'image du conteneur.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	Non	Les commandes de démarrage du conteneur. Un maximum de 20 commandes est pris en charge. Chaque commande peut contenir jusqu'à 256 caractères.
	string	Non	La commande de démarrage du conteneur. La commande peut contenir jusqu'à 256 caractères.	sleep
Args	array	Non	Les arguments pour la commande de démarrage du conteneur. Un maximum de 10 arguments est pris en charge.
	string	Non	L'argument pour la commande de démarrage du conteneur.	100
EnvironmentVars	array<object>	Non	Les informations sur les variables d'environnement.
	object	Non	Les informations sur les variables d'environnement.
Key	string	Non	Le nom de la variable d'environnement. Le nom doit comporter entre 1 et 128 caractères et peut contenir des chiffres, des lettres et des traits de soulignement (_). Il ne peut pas commencer par un chiffre.	PATH
Value	string	Non	La valeur de la variable d'environnement. La valeur peut comporter entre 0 et 256 caractères.	/usr/local/bin
FieldRefFieldPath	string	Non	Remarque Ce paramètre n'est pas disponible publiquement.	fieldPath
SkipMatching	boolean	Non	Indique si les instances correspondant à la configuration souhaitée doivent être ignorées. Remarque Le système détermine si une instance correspond en fonction de l'identifiant de la configuration de mise à l'échelle souhaitée, et non en comparant des éléments de configuration spécifiques. Valeurs valides : true : ignore les instances correspondantes. Lorsque la tâche d'actualisation des instances démarre, le système vérifie la configuration de chaque instance. Les instances qui ont déjà été créées avec la configuration souhaitée ne sont pas actualisées. false : n'ignore pas les instances correspondantes. Une fois la tâche d'actualisation des instances démarrée, toutes les instances du groupe de mise à l'échelle sont actualisées. Valeur par défaut : true.	true
Checkpoints	array<object>	Non	Les points de contrôle pour la tâche d'actualisation. Spécifie que la tâche est automatiquement mise en pause pendant la durée spécifiée par CheckpointPauseTime lorsque le pourcentage de nouvelles instances atteint la valeur spécifiée pendant l'actualisation des instances.
	object	Non	Les points de contrôle pour la tâche d'actualisation. Spécifie que la tâche est automatiquement mise en pause pendant la durée spécifiée par CheckpointPauseTime lorsque le pourcentage de nouvelles instances atteint la valeur spécifiée pendant l'actualisation des instances.
Percentage	integer	Non	Le pourcentage de nouvelles instances par rapport au nombre total d'instances dans le groupe de mise à l'échelle. La tâche est automatiquement mise en pause lorsque ce pourcentage est atteint. Valeurs valides : 1 à 100 (%). Remarque Les valeurs doivent être spécifiées par ordre croissant, et la dernière valeur de pourcentage doit être 100.	20
CheckpointPauseTime	integer	Non	La durée de la pause lorsqu'un point de contrôle de la tâche d'actualisation est atteint. Unité : minutes. Valeurs valides : 1 à 2880. Valeur par défaut : 60.	10
Strategy	string	Non	La stratégie d'exécution pour la tâche d'actualisation des instances. Valeurs valides : Rolling : la tâche d'actualisation des instances crée de nouvelles instances et libère les anciennes instances pour actualiser les instances. ReplaceSystemDisk : met à jour le disque cloud système sur les instances existantes en spécifiant DesiredConfiguration.image pour remplacer le disque cloud système des instances. Valeur par défaut : Rolling.	Rolling

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceRefreshTaskId	string	L'identifiant de la tâche d'actualisation des instances.	ir-a12ds234fasd*****

Exemples

JSON format

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

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.