GetStackGroup - - Centre de documentation Alibaba Cloud

Consulte les détails d'un groupe de piles par nom dans une région.

Description de l'opération

Cette rubrique fournit un exemple pour interroger les informations d'un groupe de piles existant nommé MyStackGroup qui utilise le modèle d'autorisations autogéré dans la région de Chine (Hangzhou).

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.

ros:GetStackGroup

get

*StackGroup.

acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du groupe de piles. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
StackGroupName	string	Non	Le nom du groupe de piles. Le nom doit être unique dans une région. Le nom peut comporter jusqu'à 255 caractères et doit commencer par un chiffre ou une lettre. Il peut contenir des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Remarque Vous ne devez spécifier qu'un seul des paramètres StackGroupName et StackGroupId.	MyStackGroup
StackGroupId	string	Non	L'identifiant du groupe de piles. Remarque Vous ne devez spécifier qu'un seul des paramètres StackGroupName et StackGroupId.	fd0ddef9-9540-4b42-a464-94f77835****

Pour plus d'informations sur les paramètres de requête courants, consultez la rubrique Paramètres communs.

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroup	object	Les détails du groupe de piles.
StackGroupId	string	L'identifiant du groupe de piles.	fd0ddef9-9540-4b42-a464-94f77835****
Status	string	L'état du groupe de piles. Valeurs valides : ACTIVE : Actif. DELETED : Supprimé.	ACTIVE
AdministrationRoleName	string	Le nom du rôle d'administrateur RAM que Resource Orchestration Service (ROS) endosse lorsque vous créez un groupe de piles qui utilise le modèle d'autorisations autogéré. Si vous ne spécifiez pas ce paramètre, la valeur par défaut AliyunROSStackGroupAdministrationRole est renvoyée.	AliyunROSStackGroupAdministrationRole
Parameters	array<object>	Les paramètres du groupe de piles.
	object
ParameterKey	string	Le nom du paramètre.	Amount
ParameterValue	string	La valeur du paramètre.	12
Description	string	La description du groupe de piles.	StackGroup Description
StackGroupName	string	Le nom du groupe de piles.	MyStackGroup
ExecutionRoleName	string	Le nom du rôle d'exécution RAM que le rôle d'administrateur (AliyunROSStackGroupAdministrationRole) endosse lorsque vous créez un groupe de piles qui utilise le modèle d'autorisations autogéré. Si vous ne spécifiez pas ce paramètre, la valeur par défaut AliyunROSStackGroupExecutionRole est renvoyée.	AliyunROSStackGroupExecutionRole
TemplateBody	string	La structure du corps du modèle. Remarque Ce paramètre de réponse n'est pas recommandé. Utilisez TemplateContent à la place.	{"ROSTemplateFormatVersion": "2015-09-01"}
StackGroupDriftDetectionDetail	object	Les détails de la dernière détection de dérive réussie pour le groupe de piles.
DriftDetectionTime	string	L'heure à laquelle la détection de dérive a été effectuée sur le groupe de piles. L'heure est au format AAAA-MM-JJThh:mm:ss.	2020-02-27T07:47:47
TotalStackInstancesCount	integer	Le nombre total d'instances de pile.	2
FailedStackInstancesCount	integer	Le nombre d'instances de pile pour lesquelles la détection de dérive a échoué.	0
DriftDetectionStatus	string	L'état de la détection de dérive du groupe de piles. Valeurs valides : COMPLETED : La détection de dérive est terminée et toutes les instances de pile ont terminé la détection de dérive avec succès. FAILED : La détection de dérive est terminée et le nombre d'instances de pile pour lesquelles la détection de dérive a échoué dépasse le seuil spécifié. PARTIAL_SUCCESS : La détection de dérive est terminée et certaines instances de pile ont échoué à la détection de dérive, mais le nombre d'instances en échec ne dépasse pas le seuil. IN_PROGRESS : La détection de dérive est en cours. STOPPED : La détection de dérive est annulée par l'utilisateur.	COMPLETED
StackGroupDriftStatus	string	L'état de dérive du groupe de piles. Valeurs valides : DRIFTED : Au moins une instance de pile a dérivé. NOT_CHECKED : Aucune détection de dérive réussie n'a été effectuée sur le groupe de piles. IN_SYNC : Toutes les instances de pile sont synchronisées.	DRIFTED
InProgressStackInstancesCount	integer	Le nombre d'instances de pile pour lesquelles la détection de dérive est en cours.	0
InSyncStackInstancesCount	integer	Le nombre d'instances de pile qui sont synchronisées.	1
CancelledStackInstancesCount	integer	Le nombre d'instances de pile pour lesquelles la détection de dérive est annulée.	0
DriftedStackInstancesCount	integer	Le nombre d'instances de pile qui ont dérivé.	1
ResourceGroupId	string	L'identifiant du groupe de ressources. La valeur dépend de l'identifiant du groupe de ressources spécifié lors de la création du groupe de piles.	rg-acfmxazb4ph6aiy****
PermissionModel	string	Le modèle d'autorisations. Valeurs valides : SELF_MANAGED : Modèle d'autorisations autogéré. SERVICE_MANAGED : Modèle d'autorisations géré par le service. Remarque Pour plus d'informations sur les modèles d'autorisations des groupes de piles, consultez la rubrique Vue d'ensemble.	SELF_MANAGED
AutoDeployment	object	Les paramètres de déploiement automatique. Remarque Ce paramètre n'est renvoyé que lorsque PermissionModel est défini sur SERVICE_MANAGED.
Enabled	boolean	Indique si le déploiement automatique doit être activé. Valeurs valides : true : active le déploiement automatique. Une fois le déploiement automatique activé, si un compte membre est ajouté au dossier cible, le groupe de piles déploie automatiquement des instances de pile dans les régions spécifiées du nouveau compte. Si un compte est supprimé du dossier cible, le groupe de piles supprime les instances de pile des régions spécifiées du compte. false : désactive le déploiement automatique. Une fois le déploiement automatique désactivé, les instances de pile ne changent pas lorsque les comptes membres du dossier cible changent.	true
RetainStacksOnAccountRemoval	boolean	Indique si les piles des comptes membres doivent être conservées lorsque des comptes membres sont supprimés du dossier cible. Valeurs valides : true : conserve les piles. false : supprime les piles. Remarque Ce paramètre n'est renvoyé que lorsque Enabled est défini sur true.	true
RdFolderIds	array	La liste des identifiants des dossiers cibles dans le répertoire de ressources. Les instances de pile sont déployées sur tous les comptes des dossiers. Remarque Ce paramètre n'est renvoyé que lorsque PermissionModel est défini sur SERVICE_MANAGED.
	string	La liste des identifiants des dossiers cibles dans le répertoire de ressources. Les instances de pile sont déployées sur tous les comptes des dossiers. Remarque Ce paramètre n'est renvoyé que lorsque PermissionModel est défini sur SERVICE_MANAGED.	["fd-4PvlVLOL8v"]
TemplateContent	string	La structure du corps du modèle au format JSON. Pour plus d'informations, consultez la rubrique Syntaxe des modèles.	{ "ROSTemplateFormatVersion": "2015-09-01" }
CreateTime	string	L'heure de création du groupe de piles. L'heure est au format AAAA-MM-JJThh:mm:ss.	2024-06-14T02:13:50
UpdateTime	string	L'heure de la dernière mise à jour du groupe de piles. L'heure est au format AAAA-MM-JJThh:mm:ss.	2024-06-15T02:01:00

Exemples

JSON format

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroup": {
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "Status": "ACTIVE",
    "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole",
    "Parameters": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "12"
      }
    ],
    "Description": "Description du groupe de piles",
    "StackGroupName": "MyStackGroup",
    "ExecutionRoleName": "AliyunROSStackGroupExecutionRole",
    "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
    "StackGroupDriftDetectionDetail": {
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "TotalStackInstancesCount": 2,
      "FailedStackInstancesCount": 0,
      "DriftDetectionStatus": "COMPLETED",
      "StackGroupDriftStatus": "DRIFTED",
      "InProgressStackInstancesCount": 0,
      "InSyncStackInstancesCount": 1,
      "CancelledStackInstancesCount": 0,
      "DriftedStackInstancesCount": 1
    },
    "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
    "PermissionModel": "SELF_MANAGED",
    "AutoDeployment": {
      "Enabled": true,
      "RetainStacksOnAccountRemoval": true
    },
    "RdFolderIds": [
      "[\"fd-4PvlVLOL8v\"]"
    ],
    "TemplateContent": "{\n      \"ROSTemplateFormatVersion\": \"2015-09-01\"\n}",
    "CreateTime": "2024-06-14T02:13:50",
    "UpdateTime": "2024-06-15T02:01:00"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.