DescribeServiceRollout - - Centre de documentation Alibaba Cloud

Consulte le plan de mise à jour du service.

Description de l'opération

Cette opération consulte la configuration du déploiement et l'état d'exécution actuel d'un service spécifique.
Les informations renvoyées incluent, sans s'y limiter, les paramètres spécifiques de la stratégie de déploiement et la progression actuelle du déploiement.
Spécifiez ClusterId et le nom du service ServiceName en tant que paramètres de chemin dans la requête.
La limite de taux de requête est de 100 requêtes par seconde.
Si le service n'existe pas ou si aucune stratégie de déploiement n'a été créée, cette opération renvoie une erreur.
L'état renvoyé est le résultat d'une requête en temps réel qui peut changer au fil du temps. Ajustez l'intervalle d'interrogation selon vos besoins.

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.

eas:DescribeServiceRollout

get

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

GET /api/v2/services/{ClusterId}/{ServiceName}/rollout HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
ClusterId	string	Non	L'identifiant de la région du cluster où réside le service.	cn-shanghai
ServiceName	string	Non	Le nom du service.	foo

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse.
RequestId	string	L'identifiant de la requête. Un identifiant unique renvoyé avec chaque requête, utilisé pour le dépannage et le suivi.	40325405-579C-4D82****
Rollout	object	Les informations sur la stratégie de déploiement. Contient la configuration de la stratégie (Strategy) et l'état d'exécution (Status).
Strategy	object	La configuration de la stratégie de déploiement. Contient les paramètres de configuration spécifiques pour un déploiement basé sur des partitions ou des lots.
Partition	object	La configuration du déploiement par partition. Ce champ n'est renvoyé que si une stratégie de déploiement basée sur des partitions est utilisée.
Partition	string	La valeur de la partition. Spécifie le nombre ou le pourcentage d'anciennes répliques à conserver. Par exemple, « 50 % » indique que 50 % des anciennes répliques sont conservées.	50%
Batch	object	La configuration du déploiement par lot. Ce champ n'est renvoyé que si une stratégie de déploiement basée sur des lots est utilisée.
BatchSize	string	La taille du lot. Le nombre ou le pourcentage de répliques à mettre à jour dans chaque lot.	1
Interval	string	L'intervalle entre les lots. Le temps d'attente entre deux lots de déploiement consécutifs.	5m
Status	object	L'état d'exécution du déploiement. Contient la progression actuelle du déploiement et les informations de phase.
Phase	string	La phase de déploiement. Valeurs valides : Pending : en attente du démarrage du déploiement. Running : le déploiement est en cours. Paused : le déploiement est en pause. Completed : le déploiement est terminé. Failed : le déploiement a échoué. Valeurs valides : Failed : Le déploiement a échoué. Completed : Le déploiement est terminé. Running : Le déploiement est en cours. Pending : En attente du démarrage du déploiement. Paused : Le déploiement est en pause.	Running
TotalReplicas	integer	Le nombre total de répliques pour le service.	10
UpdatedReplicas	integer	Le nombre de répliques qui ont été mises à jour vers la nouvelle version.	5
CurrentRevision	string	La révision actuelle. L'identifiant de la version qui est actuellement en cours d'exécution.	service-abc123-v1
UpdateRevision	string	La révision de mise à jour. L'identifiant de la version cible vers laquelle le service est mis à jour.	service-abc123-v2
NextBatchStartTime	string	L'heure à laquelle le lot suivant commence la mise à jour, au format AAAA/MM/JJ HH:mm:ss.	2026/05/08 16:10:56

Exemples

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Rollout": {
    "Strategy": {
      "Partition": {
        "Partition": "50%"
      },
      "Batch": {
        "BatchSize": "1",
        "Interval": "5m"
      }
    },
    "Status": {
      "Phase": "Running",
      "TotalReplicas": 10,
      "UpdatedReplicas": 5,
      "CurrentRevision": "service-abc123-v1",
      "UpdateRevision": "service-abc123-v2",
      "NextBatchStartTime": "2026/05/08 16:10:56"
    }
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.