ListStackGroups - - Centre de documentation Alibaba Cloud

Cette rubrique explique comment interroger la liste des groupes de piles. L'exemple ci-dessous filtre les groupes de piles actifs déployés dans la région Chine (Hangzhou).

Débogage

OpenAPI Explorer calcule automatiquement la signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListStackGroups	Opération à effectuer. Définissez la valeur sur ListStackGroups.
RegionId	String	Yes	cn-hangzhou	ID de région du groupe de piles. Appelez l'opération DescribeRegions pour obtenir la liste des régions disponibles.
Status	String	No	ACTIVE	État du groupe de piles. Si vous omettez ce paramètre, la requête renvoie les groupes de piles dans tous les états de la région spécifiée. Valeurs valides : ACTIVE DELETED
PageSize	Long	No	10	Nombre d'entrées par page. Valeurs valides : 1 à 50. Valeur par défaut : 10.
PageNumber	Long	No	1	Numéro de la page à renvoyer. La numérotation commence à 1. Valeur par défaut : 1.
ResourceGroupId	String	No	rg-acfmzawhxxcj****	ID du groupe de ressources. Si vous omettez ce paramètre, la requête renvoie les groupes de piles de tous les groupes de ressources. Remarque Pour obtenir l'ID du groupe de ressources, accédez à la page Resource Group de la console Resource Management. Pour plus d'informations, consultez View basic information about a resource group.
Tags.N.Key	String	Yes	usage	Clé du tag N ajouté au groupe de piles. Remarque Le paramètre Tags est facultatif. Toutefois, si vous le spécifiez, vous devez également spécifier Tags.N.Key.
Tags.N.Value	String	No	test	Valeur du tag N ajouté au groupe de piles.

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

Paramètres de réponse

Parameter	Type	Example	Description
StackGroups	Array of StackGroup		Liste des groupes de piles.
StackGroupId	String	fd0ddef9-9540-4b42-a464-94f77835****	ID du groupe de piles.
Status	String	ACTIVE	État du groupe de piles. Valeurs valides : ACTIVE DELETED
DriftDetectionTime	String	2020-02-27T07:47:47	Horodatage de la dernière détection de dérive réussie sur le groupe de piles.
Description	String	My Stack Group	Description du groupe de piles.
StackGroupDriftStatus	String	IN_SYNC	État du groupe de piles lors de la dernière détection de dérive réussie. Valeurs valides : DRIFTED : Le groupe de piles présente une dérive. NOT_CHECKED : Aucune détection de dérive n'a été effectuée sur le groupe de piles. IN_SYNC : Aucune dérive détectée sur le groupe de piles.
StackGroupName	String	MyStackGroup	Nom du groupe de piles.
Tags	Array of Tags		Tags ajoutés au groupe de piles.
Key	String	usage1	Clé du tag ajouté au groupe de piles.
Value	String	test1	Valeur du tag ajouté au groupe de piles.
ResourceGroupId	String	rg-acfmzawhxxcj****	ID du groupe de ressources.
PermissionModel	String	SELF_MANAGED	Modèle d'autorisation. Valeurs valides : SELF_MANAGED : modèle d'autorisation autogéré SERVICE_MANAGED : modèle d'autorisation géré par le service Remarque Pour plus d'informations sur les modèles d'autorisation des groupes de piles, consultez Overview.
AutoDeployment	Object		Informations relatives aux paramètres de déploiement automatique.
Enabled	Boolean	true	Indique si le déploiement automatique est activé. Valeurs valides : true : Le déploiement automatique est activé. Si vous ajoutez un compte membre au dossier associé au groupe de piles après avoir activé cette option, ROS déploie automatiquement les piles du groupe dans la région spécifiée du compte membre. Si vous supprimez le compte membre du dossier, ROS supprime automatiquement les piles correspondantes de la région spécifiée. false : Le déploiement automatique est désactivé. Les piles restent inchangées lors des modifications apportées aux comptes membres du dossier.
RetainStacksOnAccountRemoval	Boolean	true	Indique si les piles du compte membre sont conservées lors de la suppression de ce dernier du dossier. Valeurs valides : true false Remarque Ce paramètre n'est renvoyé que si Enabled est défini sur true.
TotalCount	Integer	1	Nombre total de groupes de piles.
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	ID de la requête.
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
PageNumber	Integer	1	Numéro de la page renvoyée.

Exemples

Exemple de requête

http(s)://ros.aliyuncs.com/?Action=ListStackGroups
&RegionId=cn-hangzhou
&Status=ACTIVE
&<Common request parameters>

Exemple de réponse correcte

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListStackGroupsResponse>
    <StackGroups>
        <StackGroupId>fd0ddef9-9540-4b42-a464-94f77835****</StackGroupId>
        <Status>ACTIVE</Status>
        <DriftDetectionTime>2020-02-27T07:47:47</DriftDetectionTime>
        <Description>My Stack Group</Description>
        <StackGroupDriftStatus>IN_SYNC</StackGroupDriftStatus>
        <StackGroupName>MyStackGroup</StackGroupName>
        <Tags>
            <Key>usage1</Key>
            <Value>test1</Value>
        </Tags>
        <ResourceGroupId>rg-acfmzawhxxcj****</ResourceGroupId>
        <PermissionModel>SELF_MANAGED</PermissionModel>
        <AutoDeployment>
            <Enabled>true</Enabled>
            <RetainStacksOnAccountRemoval>true</RetainStacksOnAccountRemoval>
        </AutoDeployment>
    </StackGroups>
    <TotalCount>1</TotalCount>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
</ListStackGroupsResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "StackGroups" : {
    "StackGroupId" : "fd0ddef9-9540-4b42-a464-94f77835****",
    "Status" : "ACTIVE",
    "DriftDetectionTime" : "2020-02-27T07:47:47",
    "Description" : "My Stack Group",
    "StackGroupDriftStatus" : "IN_SYNC",
    "StackGroupName" : "MyStackGroup",
    "Tags" : {
      "Key" : "usage1",
      "Value" : "test1"
    },
    "ResourceGroupId" : "rg-acfmzawhxxcj****",
    "PermissionModel" : "SELF_MANAGED",
    "AutoDeployment" : {
      "Enabled" : true,
      "RetainStacksOnAccountRemoval" : true
    }
  },
  "TotalCount" : 1,
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "PageSize" : 10,
  "PageNumber" : 1
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.

Error code	Error message	HTTP status code	Description
InvalidParameter	The specified parameter {name} is invalid, {reason}.	400	Le paramètre spécifié n'est pas valide. name indique le nom du paramètre. reason précise la cause de l'erreur.