DescribeInstanceRefreshes - Auto Scaling - Centre de documentation Alibaba Cloud

Consulte les tâches d'actualisation des instances d'un groupe de mise à l'échelle pour afficher les informations de base et la progression de la tâche.

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:DescribeInstanceRefreshes

get

*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
NextToken	string	Non	Le jeton de requête. Définissez la valeur sur la valeur NextToken renvoyée lors de l'appel précédent. Vous n'avez pas besoin de spécifier ce paramètre lors du premier appel.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	Non	Le nombre maximal d'entrées par page pour une requête paginée. Valeurs valides : 1 à 50. Valeur par défaut : 10.	10
ScalingGroupId	string	Non	L'identifiant du groupe de mise à l'échelle. Remarque Lorsque vous appelez cette opération, vous devez spécifier soit ScalingGroupId, soit InstanceRefreshTaskIds. Si aucun des deux n'est spécifié, une erreur se produit.	asg-bp1ffogfdauy0jw0****
InstanceRefreshTaskIds	array	Non	Les identifiants des tâches d'actualisation des instances à interroger.
	string	Non	Les identifiants des tâches d'actualisation des instances à interroger.	ir-adfa12312*****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	Le jeton pour la requête suivante. Un NextToken vide indique qu'il n'y a plus de résultats disponibles.	caeba0bbb2be03f84eb48b699f****
MaxResults	integer	Le nombre maximal d'entrées par page.	50
TotalCount	integer	Le nombre total de tâches d'actualisation des instances.	100
InstanceRefreshTasks	array<object>	La liste des tâches d'actualisation des instances.
	array<object>	La tâche d'actualisation des instances.
ScalingGroupId	string	L'identifiant du groupe de mise à l'échelle.	asg-bp16pbfcr8j9*****
InstanceRefreshTaskId	string	L'identifiant de la tâche d'actualisation des instances.	ir-1adfa123****
RegionId	string	L'identifiant de la région du groupe de mise à l'échelle.	cn-hangzhou
EndTime	string	L'heure de fin de la tâche d'actualisation des instances. L'heure est affichée en UTC et suit la norme ISO 8601 au format YYYY-MM-DDTHH:mm:ssZ.	2024-08-22T02:09:00Z
StartTime	string	L'heure de début de la tâche d'actualisation des instances. L'heure est affichée en UTC et suit la norme ISO 8601 au format YYYY-MM-DDTHH:mm:ssZ.	2024-08-22T01:09:00Z
Status	string	L'état actuel de la tâche d'actualisation des instances. Valeurs valides : Pending : la tâche d'actualisation des instances est créée et en attente de planification. InProgress : la tâche d'actualisation des instances est en cours. Paused : la tâche d'actualisation des instances est en pause. CheckpointPause : la tâche d'actualisation des instances est en pause car la progression de la tâche a atteint le point de contrôle de la tâche d'actualisation (Checkpoint.Percentage). Failed : la tâche d'actualisation des instances a échoué. Successful : la tâche d'actualisation des instances a réussi. Cancelling : la tâche d'actualisation des instances est en cours d'annulation. Cancelled : la tâche d'actualisation des instances est annulée. RollbackInProgress : la tâche d'actualisation des instances est en cours de restauration. RollbackSuccessful : la tâche d'actualisation des instances a été restaurée. RollbackFailed : la restauration de la tâche d'actualisation des instances a échoué.	InProgress
Detail	string	La cause spécifique de l'échec lorsque la tâche d'actualisation des instances échoue.	The task exceeded its maximum run time of one week. So the task failed.
MinHealthyPercentage	integer	Le pourcentage minimal d'instances qui doivent rester en service dans le groupe de mise à l'échelle pendant l'actualisation des instances.	80
MaxHealthyPercentage	integer	Le pourcentage maximal dont le nombre d'instances du groupe de mise à l'échelle peut dépasser la capacité du groupe de mise à l'échelle lors de l'actualisation des instances.	120
DesiredConfiguration	object	La configuration souhaitée pour l'actualisation des instances.
ImageId	string	L'identifiant du fichier image, qui est la ressource d'image utilisée pour la création automatique des instances.	m-uf6g5noisr****
ScalingConfigurationId	string	L'identifiant de la configuration de mise à l'échelle.	asc-wz91ibkhfor****
LaunchTemplateId	string	L'identifiant du modèle de lancement, qui spécifie que le groupe de mise à l'échelle obtient les informations de configuration de lancement à partir du modèle de lancement.	lt-2ze5x4mp*****
LaunchTemplateVersion	string	La version du modèle de lancement. Valeurs valides : Un numéro de version de modèle spécifique. Default : utilise toujours la version par défaut du modèle. Latest : utilise toujours la dernière version du modèle.	Latest
LaunchTemplateOverrides	array<object>	Les informations de remplacement du type d'instance pour le modèle de lancement.
	object	Les informations de remplacement du type d'instance pour le modèle de lancement.
InstanceType	string	Le type d'instance spécifié, qui remplace le type d'instance dans le modèle de lancement.	ecs.sn1ne.large
Containers	array<object>	La liste des conteneurs inclus dans l'instance.
	array<object>	La liste des conteneurs inclus dans l'instance.
Name	string	Le nom personnalisé du conteneur.	name
Image	string	L'image du conteneur.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	La commande de démarrage du conteneur.
	string	La commande de démarrage du conteneur.	sleep
Args	array	Les arguments de la commande de démarrage du conteneur.
	string	Les arguments de la commande de démarrage du conteneur.	100
EnvironmentVars	array<object>	Les informations sur les variables d'environnement.
	object	Les informations sur les variables d'environnement.
Key	string	Le nom de la variable d'environnement.	PATH
Value	string	La valeur de la variable d'environnement.	/usr/local/bin
FieldRefFieldPath	string	Remarque Ce paramètre n'est pas disponible.	fieldPath
FinishedUpdateCapacity	integer	La capacité qui a été actualisée.	10
TotalNeedUpdateCapacity	integer	La capacité totale qui doit être actualisée.	20
SkipMatching	boolean	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, sans comparer d'é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 déjà 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.	true
CheckpointPauseTime	integer	La durée de la pause lorsqu'un point de contrôle de la tâche d'actualisation est atteint. Unité : minutes.	30
Checkpoints	array<object>	Les points de contrôle de la tâche d'actualisation. Spécifie que pendant l'actualisation des instances, la tâche est automatiquement mise en pause pendant CheckpointPauseTime minutes lorsque le pourcentage de nouvelles instances atteint la valeur spécifiée.
	object	Les points de contrôle de la tâche d'actualisation. Spécifie que pendant l'actualisation des instances, la tâche est automatiquement mise en pause pendant CheckpointPauseTime minutes lorsque le pourcentage de nouvelles instances atteint la valeur spécifiée.
Percentage	integer	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.	60
Strategy	string	La stratégie d'exécution de 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. ReplaceSystemDisk : met à jour le disque système sur les instances existantes.	Rolling

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken": "caeba0bbb2be03f84eb48b699f****",
  "MaxResults": 50,
  "TotalCount": 100,
  "InstanceRefreshTasks": [
    {
      "ScalingGroupId": "asg-bp16pbfcr8j9*****",
      "InstanceRefreshTaskId": "ir-1adfa123****",
      "RegionId": "cn-hangzhou",
      "EndTime": "2024-08-22T02:09:00Z",
      "StartTime": "2024-08-22T01:09:00Z",
      "Status": "InProgress",
      "Detail": "La tâche a dépassé sa durée d'exécution maximale d'une semaine. Elle a donc échoué",
      "MinHealthyPercentage": 80,
      "MaxHealthyPercentage": 120,
      "DesiredConfiguration": {
        "ImageId": "m-uf6g5noisr****",
        "ScalingConfigurationId": "asc-wz91ibkhfor****",
        "LaunchTemplateId": "lt-2ze5x4mp*****",
        "LaunchTemplateVersion": "Latest",
        "LaunchTemplateOverrides": [
          {
            "InstanceType": "ecs.sn1ne.large"
          }
        ],
        "Containers": [
          {
            "Name": "nom",
            "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
            "Commands": [
              "sleep"
            ],
            "Args": [
              "100"
            ],
            "EnvironmentVars": [
              {
                "Key": "PATH",
                "Value": "/usr/local/bin",
                "FieldRefFieldPath": "fieldPath"
              }
            ]
          }
        ]
      },
      "FinishedUpdateCapacity": 10,
      "TotalNeedUpdateCapacity": 20,
      "SkipMatching": true,
      "CheckpointPauseTime": 30,
      "Checkpoints": [
        {
          "Percentage": 60
        }
      ],
      "Strategy": "Rolling"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.