StartInstanceRefresh - Auto Scaling - Centre de documentation Alibaba Cloud

Actualise les instances d'un groupe de mise à l'échelle pour appliquer une nouvelle configuration de mise à l'échelle ou mettre à jour les images des instances.

Description de l'opération

Un groupe de mise à l'échelle ne peut avoir qu'un seul nœud d'actualisation d'instance en cours d'exécution à la fois.
Cette fonctionnalité n'est prise en charge que pour les groupes de mise à l'échelle ECS qui utilisent la stratégie de priorité comme stratégie d'extension. Les groupes de mise à l'échelle qui utilisent le nombre de vCPU pour calculer la capacité du groupe de mise à l'échelle et les groupes de mise à l'échelle dont le mode de retrait des instances est défini sur mode de retrait par arrêt ou mode de retrait par arrêt forcé ne prennent pas en charge cette fonctionnalité.
Lors d'une actualisation d'instance, les activités normales d'extension et de réduction peuvent être effectuées. Cependant, les activités d'extension utilisent la configuration souhaitée spécifiée pour l'actualisation des instances.
Les instances ajoutées manuellement au groupe de mise à l'échelle, ou qui sont en état de veille ou en statut de protection, sont ignorées par le nœud d'actualisation d'instance et ne sont pas actualisées.

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
ScalingGroupId	string	Oui	L'identifiant du groupe de mise à l'échelle.	asg-bp18p2yfxow2dloq****
ClientToken	string	Non	Garantit l'idempotence de la requête. Vous pouvez générer la valeur sur le client pour vous assurer qu'elle est unique pour différentes requêtes. La valeur ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères. Pour plus d'informations, consultez Comment garantir l'idempotence.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	Oui	L'identifiant de la région du groupe de mise à l'échelle.	cn-hangzhou
MinHealthyPercentage	integer	Non	Le pourcentage minimum de la capacité du groupe de mise à l'échelle qui doit rester en service 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 MinHealthyPercentage et MaxHealthyPercentage sont tous deux définis sur 100, une instance est actualisée à la fois.	100
DesiredConfiguration	object	Non	La configuration souhaitée pour l'actualisation des instances. Remarque ScalingConfigurationId, ImageId, LaunchTemplateId et Containers ne peuvent pas être spécifiés en même temps. Si ce paramètre est laissé vide, les instances sont actualisées en fonction de la configuration active du groupe de mise à l'échelle. Une fois la tâche d'actualisation des instances exécutée avec succès, la configuration de mise à l'échelle active du groupe de mise à l'échelle est mise à jour vers cette configuration.
ImageId	string	Non	L'identifiant de l'image. Remarque Une fois la tâche d'actualisation des instances exécutée avec succès, 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 si la source de la configuration active 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.	asc-2zed7lqn4ts4****
LaunchTemplateId	string	Non	L'identifiant du modèle de lancement. Ce paramètre permet de spécifier que le groupe de mise à l'échelle obtient les configurations 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 spécifique du modèle. Default : utilise toujours la version par défaut du modèle. Latest : utilise toujours la dernière version du modèle. Remarque Si la version est définie sur Default ou Latest, la tâche d'actualisation des instances ne peut pas être annulée.	8
LaunchTemplateOverrides	array<object>	Non	Les remplacements de type d'instance pour le modèle de lancement.
	object	Non	Les remplacements de type d'instance pour le modèle de lancement.
InstanceType	string	Non	Ce paramètre permet de spécifier le type d'instance, qui remplace le type d'instance dans le modèle de lancement. Remarque Ce paramètre prend effet uniquement lorsque le paramètre LaunchTemplateId est spécifié.	ecs.c5.2xlarge
Containers	array<object>	Non	La liste des conteneurs inclus dans l'instance. Remarque Ce paramètre n'est pris en charge que pour les groupes de mise à l'échelle Elastic Container Instance (ECI). Seules les configurations de conteneur dont le Container.Name correspond aux noms des conteneurs dans la configuration de mise à l'échelle actuelle sont actualisées.
	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 pour le conteneur. Vous pouvez spécifier jusqu'à 20 commandes. Chaque commande peut contenir jusqu'à 256 caractères.
	string	Non	Les commandes de démarrage pour le conteneur. Vous pouvez spécifier jusqu'à 20 commandes. Chaque commande peut contenir jusqu'à 256 caractères.	sleep
Args	array	Non	Les arguments pour les commandes de démarrage du conteneur. Vous pouvez spécifier jusqu'à 10 arguments.
	string	Non	Les arguments pour les commandes de démarrage du conteneur. Vous pouvez spécifier jusqu'à 10 arguments.	100
EnvironmentVars	array<object>	Non	Les variables d'environnement.
	object	Non	Les variables d'environnement.
Key	string	Non	Le nom de la variable d'environnement. Le nom doit comporter de 1 à 128 caractères. Il peut contenir des lettres, des chiffres et des traits de soulignement (_), et ne peut pas commencer par un chiffre.	PATH
Value	string	Non	La valeur de la variable d'environnement. La valeur doit comporter de 0 à 256 caractères.	/usr/local/bin
FieldRefFieldPath	string	Non	Remarque Ce paramètre n'est pas disponible.	fieldPath
SkipMatching	boolean	Non	Indique s'il faut ignorer les instances qui correspondent à la configuration souhaitée. Remarque Le système détermine si une instance correspond à la configuration souhaitée en fonction de l'identifiant de la configuration de mise à l'échelle souhaitée, sans comparer d'éléments de configuration spécifiques. Valeurs valides : true : ignore les instances. Lorsque la tâche d'actualisation des instances est démarrée, le système vérifie la configuration de chaque instance. Les instances déjà créées avec la configuration souhaitée ne sont pas actualisées. false : n'ignore pas les instances. 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. Ce paramètre spécifie que la tâche est automatiquement mise en pause pendant la durée spécifiée par CheckpointPauseTime en minutes 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. Ce paramètre spécifie que la tâche est automatiquement mise en pause pendant la durée spécifiée par CheckpointPauseTime en minutes 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 sur le total des instances dans le groupe de mise à l'échelle. Lorsque ce pourcentage est atteint, la tâche est automatiquement mise en pause. Valeurs valides : 1 à 100. Unité : %. Remarque Les valeurs doivent être définies par ordre croissant, et le dernier 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 : actualise les instances en créant de nouvelles instances et en libérant les anciennes instances. ReplaceSystemDisk : met à jour les disques cloud système des instances existantes en spécifiant DesiredConfiguration.image. 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.