GetStack - - Centre de documentation Alibaba Cloud

Cette rubrique explique comment interroger les informations d'une pile dont l'ID est c754d2a4-28f1-46df-b557-9586173a****. La pile est déployée dans la région Chine (Hangzhou).

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetStack	L'opération que vous souhaitez exécuter. Définissez la valeur sur GetStack.
StackId	String	Oui	c754d2a4-28f1-46df-b557-9586173a****	L'ID de la pile.
RegionId	String	Oui	cn-hangzhou	L'ID de la région où réside la pile. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste la plus récente des régions Alibaba Cloud.
ClientToken	String	Non	123e4567-e89b-12d3-a456-42665544****	Le jeton client utilisé pour garantir l'idempotence de la requête. Générez la valeur via le client, en veillant à ce qu'elle soit unique pour chaque requête. La longueur du jeton peut atteindre 64 caractères. Pour plus d'informations, consultez Garantir l'idempotence.
OutputOption	String	Non	Disabled	Indique s'il faut renvoyer les paramètres de sortie de la pile. Valeurs valides : Enabled : renvoie les paramètres de sortie. Il s'agit de la valeur par défaut. Disabled : ne renvoie pas les paramètres de sortie. Remarque Le calcul des paramètres de sortie prend beaucoup de temps. Si vous n'avez pas besoin d'interroger ces paramètres, définissez OutputOption sur Disabled pour améliorer la vitesse de réponse de l'opération GetStack.
ShowResourceProgress	String	Non	Disabled	Indique s'il faut renvoyer le paramètre ResourceProgress. Valeurs valides : Disabled : ne renvoie pas le paramètre ResourceProgress. Il s'agit de la valeur par défaut. EnabledIfCreateStack : renvoie le paramètre ResourceProgress uniquement si une pile est créée. Remarque Une pile se trouve dans l'un des états suivants lors de sa création : CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, CREATE_ROLLBACK_IN_PROGRESS, CREATE_ROLLBACK_COMPLETE ou CREATE_ROLLBACK_FAILED.
LogOption	String	Non	Stack	L'option de renvoi des journaux. Valeurs valides : None : ne renvoie pas de journaux. Stack : renvoie les journaux de la pile. Il s'agit de la valeur par défaut. Resource : renvoie les journaux des ressources de la pile. All : renvoie les journaux de toutes les ressources.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
Status	String	CREATE_COMPLETE	L'état de la pile. Valeurs valides : CREATE_IN_PROGRESS : La pile est en cours de création. CREATE_FAILED : Échec de la création de la pile. CREATE_COMPLETE : La pile est créée. UPDATE_IN_PROGRESS : La pile est en cours de mise à jour. UPDATE_FAILED : Échec de la mise à jour de la pile. UPDATE_COMPLETE : La pile est mise à jour. DELETE_IN_PROGRESS : La pile est en cours de suppression. DELETE_FAILED : Échec de la suppression de la pile. CREATE_ROLLBACK_IN_PROGRESS : La pile fait l'objet d'un retour arrière après l'échec de sa création. CREATE_ROLLBACK_FAILED : Échec du retour arrière de la pile après l'échec de sa création. CREATE_ROLLBACK_COMPLETE : La pile fait l'objet d'un retour arrière après l'échec de sa création. ROLLBACK_IN_PROGRESS : Les ressources de la pile font l'objet d'un retour arrière. ROLLBACK_FAILED : Échec du retour arrière des ressources de la pile. ROLLBACK_COMPLETE : Les ressources de la pile font l'objet d'un retour arrière. CHECK_IN_PROGRESS : La pile est en cours de validation. CHECK_FAILED : Échec de la validation de la pile. CHECK_COMPLETE : La pile est validée. REVIEW_IN_PROGRESS : La pile est en cours d'examen. IMPORT_CREATE_IN_PROGRESS : La pile est en cours de création à l'aide de ressources importées. IMPORT_CREATE_FAILED : Échec de la création de la pile à l'aide de ressources importées. IMPORT_CREATE_COMPLETE : La pile est créée à l'aide de ressources importées. IMPORT_CREATE_ROLLBACK_IN_PROGRESS : Les ressources font l'objet d'un retour arrière après l'échec de la création de la pile à l'aide de ressources importées. IMPORT_CREATE_ROLLBACK_FAILED : Échec du retour arrière des ressources après l'échec de la création de la pile à l'aide de ressources importées. IMPORT_CREATE_ROLLBACK_COMPLETE : Les ressources font l'objet d'un retour arrière après l'échec de la création de la pile à l'aide de ressources importées. IMPORT_UPDATE_IN_PROGRESS : La pile est en cours de mise à jour à l'aide de ressources importées. IMPORT_UPDATE_FAILED : Échec de la mise à jour de la pile à l'aide de ressources importées. IMPORT_UPDATE_COMPLETE : La pile est mise à jour à l'aide de ressources importées. IMPORT_UPDATE_ROLLBACK_IN_PROGRESS : Les ressources font l'objet d'un retour arrière après l'échec de la mise à jour de la pile à l'aide de ressources importées. IMPORT_UPDATE_ROLLBACK_FAILED : Échec du retour arrière des ressources après l'échec de la mise à jour de la pile à l'aide de ressources importées. IMPORT_UPDATE_ROLLBACK_COMPLETE : Les ressources font l'objet d'un retour arrière après l'échec de la mise à jour de la pile à l'aide de ressources importées.
Description	String	Create a VPC.	La description de la pile.
Parameters	Array of Parameter		Les paramètres de la pile.
ParameterKey	String	ALIYUN::Region	Le nom du paramètre.
ParameterValue	String	cn-hangzhou	La valeur du paramètre.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84B6E6F	L'ID de la requête.
StatusReason	String	Stack CREATE completed successfully	La raison de l'état actuel de la pile.
ParentStackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf692****	L'ID de la pile parente.
CreateTime	String	2020-09-16T08:21:40	L'heure de création de la pile. L'heure suit la norme ISO 8601 au format AAAA-MM-JJThh:mm:ss et est affichée en UTC.
DeletionProtection	String	Disabled	Indique si la protection contre la suppression est activée pour la pile. Valeurs valides : Enabled : La protection contre la suppression est activée pour la pile. Disabled : La protection contre la suppression est désactivée pour la pile. Vous pouvez supprimer la pile dans la console Resource Orchestration Service (ROS) ou en appelant l'opération DeleteStack. Remarque La protection contre la suppression d'une pile imbriquée fonctionne de la même manière que celle de la pile racine.
RootStackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf692****	L'ID de la pile racine. Ce paramètre est renvoyé si la pile spécifiée est une pile imbriquée.
TemplateDescription	String	Create a VPC.	La description du modèle.
StackType	String	ROS	Le type de pile. Valeurs valides : ROS : Pile ROS, créée à l'aide d'un modèle ROS. Terraform : Pile Terraform, créée à l'aide d'un modèle Terraform.
RamRoleName	String	test-role	Le nom du rôle RAM. ROS endosse le rôle RAM pour créer la pile et utilise les identifiants du rôle pour appeler les API des services Alibaba Cloud. ROS endosse le rôle RAM pour effectuer des opérations sur la pile. Si vous disposez des autorisations nécessaires pour effectuer des opérations sur la pile, mais pas pour utiliser le rôle RAM, ROS endosse tout de même le rôle RAM. Veillez à appliquer le principe du moindre privilège au rôle. Si vous ne spécifiez pas ce paramètre, ROS endosse un rôle existant associé à la pile. Si aucun rôle n'est disponible, ROS utilise un identifiant temporaire généré à partir des identifiants de votre compte. La longueur du nom du rôle RAM peut atteindre 64 octets.
UpdateTime	String	2020-09-17T08:21:40	L'heure de mise à jour de la pile. L'heure suit la norme ISO 8601 au format AAAA-MM-JJThh:mm:ss et est affichée en UTC.
Outputs	Array of Object	[{"Description": "VPC ID","OutputKey": "VpcId","OutputValue": "vpc-bp1m6fww66xbntjyc****"}]	Les paramètres de sortie de la pile. Remarque Ce paramètre est renvoyé si le paramètre OutputOption est défini sur Enabled.
DriftDetectionTime	String	2020-09-16T09:21:40	L'heure de la dernière opération de détection de dérive réussie.
RegionId	String	cn-hangzhou	L'ID de la région dans laquelle la pile est déployée. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste la plus récente des régions Alibaba Cloud.
StackDriftStatus	String	IN_SYNC	L'état de la pile lors de la dernière détection de dérive réussie. Valeurs valides : DRIFTED : La pile a subi une dérive. NOT_CHECKED : Aucune détection de dérive réussie n'a été effectuée sur la pile. IN_SYNC : La pile est synchronisée.
NotificationURLs	Array of String	["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"]	Les URL de rappel utilisées pour recevoir les événements de la pile.
DisableRollback	Boolean	false	Indique si le retour arrière est désactivé en cas d'échec de la création de la pile. Valeurs valides : true : Le retour arrière est désactivé en cas d'échec de la création de la pile. false : Le retour arrière est activé en cas d'échec de la création de la pile. Il s'agit de la valeur par défaut.
StackName	String	MyStack	Le nom de la pile. Le nom peut comporter jusqu'à 255 caractères et contenir des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Il doit commencer par un chiffre ou une lettre.
Tags	Array of Tag		Les tags de la pile.
Key	String	usage	La clé de tag de la pile.
Value	String	test	La valeur de tag de la pile.
TimeoutInMinutes	Integer	10	Le délai d'expiration pour la création de la pile. Unité : minutes.
StackId	String	c754d2a4-28f1-46df-b557-9586173a****	L'ID de la pile.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	L'ID du groupe de ressources auquel appartiennent les instances.
ResourceProgress	Object		La progression de la création des ressources.
TotalResourceCount	Integer	2	Le nombre total de ressources.
SuccessResourceCount	Integer	1	Le nombre de ressources créées.
FailedResourceCount	Integer	0	Le nombre de ressources dont la création a échoué.
InProgressResourceCount	Integer	1	Le nombre de ressources en cours de création.
PendingResourceCount	Integer	0	Le nombre de ressources en attente de création.
InProgressResourceDetails	Array of InProgressResourceDetail		Les détails de progression des ressources en cours de création.
ResourceName	String	WaitCondition	Le nom de la ressource.
ResourceType	String	ALIYUN::ROS::WaitCondition	Le type de ressource.
ProgressValue	Float	5	La valeur de progression actuelle de la ressource.
ProgressTargetValue	Float	10	La valeur de progression cible de la ressource.
Log	Object		Les journaux de la pile.
TerraformLogs	Array of TerraformLog		Les journaux de la pile Terraform. Ce paramètre est renvoyé uniquement pour une pile Terraform. Ce paramètre est renvoyé si le paramètre LogOption est laissé vide ou défini sur Stack ou All. Remarque Ce paramètre n'est pas renvoyé pour une pile en cours d'exécution. Les journaux sont générés à partir de la dernière opération de création, de recréation, de mise à jour ou de suppression de la pile.
Command	String	apply	Le nom d'une commande Terraform exécutée. Valeurs valides : apply plan destroy version Pour plus d'informations sur les commandes Terraform, consultez Fonctionnalités CLI de base.
Stream	String	stdout	Le flux de sortie. Valeurs valides : stdout : le flux de sortie standard. stderr : le flux d'erreur standard.
Content	String	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.	Le contenu du flux de sortie renvoyé après l'exécution de la commande.
ResourceLogs	Array of ResourceLog		Les journaux des ressources de la pile. Ce paramètre est renvoyé si le paramètre LogOption est défini sur Resource ou All. Remarque Les journaux sont renvoyés pour les ressources de types spécifiques, telles que `ALIYUN::ROS::ResourceCleaner`.
ResourceName	String	MyResourceCleaner	Le nom de la ressource définie dans le modèle.
Logs	Array of Log		Les journaux de toutes les ressources.
Keys	Array of String	ResourceDetails	Les mots-clés.
Content	String	[]	Le contenu d'un journal de ressource.
TemplateId	String	a52f81be-496f-4e1c-a286-8852ab54****	L'ID du modèle. Ce paramètre est renvoyé uniquement si le modèle actuel de la pile est un modèle personnalisé ou un modèle partagé. Si le modèle est un modèle partagé, la valeur de ce paramètre est identique à celle du paramètre TemplateARN.
TemplateVersion	String	v1	La version du modèle. Ce paramètre est renvoyé uniquement si le modèle actuel de la pile est un modèle personnalisé ou un modèle partagé. Si le modèle est un modèle partagé, ce paramètre est renvoyé uniquement lorsque le paramètre VersionOption est défini sur AllVersions. Valeurs valides : v1 à v100.
TemplateScratchId	String	ts-7f7a704cf71c49a6****	L'ID du scénario. Ce paramètre est renvoyé uniquement si le modèle actuel de la pile est généré à partir d'un scénario.
TemplateURL	String	oss://ros/template/demo	L'URL du fichier contenant le corps du modèle. Ce paramètre est renvoyé uniquement si le modèle actuel de la pile provient d'une URL. L'URL peut pointer vers un modèle situé sur un serveur web HTTP ou HTTPS ou dans un compartiment Alibaba Cloud Object Storage Service (OSS).
Interface	String	{}	La description de l'interface utilisateur web dans la console ROS.
ServiceManaged	Boolean	false	Indique si la pile est une pile gérée. Valeurs valides : true false
ServiceName	String	ACVS	Le nom du service auquel appartient la pile gérée.
OperationInfo	Object		Les informations supplémentaires affichées lorsqu'une erreur se produit lors d'une opération sur une pile. Remarque Cette propriété est renvoyée dans des conditions spécifiques. Au moins une sous-propriété est renvoyée. Par exemple, une erreur est signalée lorsque vous appelez l'API d'un autre service cloud.
Code	String	DependencyViolation	Le code d'erreur renvoyé.
Message	String	There is still instance(s) in the specified security group.	Le message d'erreur renvoyé.
RequestId	String	071D6166-3F6B-5C7B-A1F0-0113FBB643A8	L'ID de la requête pour appeler l'API d'un autre service cloud.
Action	String	DeleteSecurityGroup	Le nom de l'API d'un autre service cloud.
ResourceType	String	ALIYUN::ECS::SecurityGroup	Le type de ressource sur lequel l'erreur d'opération s'est produite.
LogicalResourceId	String	EcsSecurityGroup	L'ID logique de la ressource sur laquelle l'erreur d'opération s'est produite.

Exemples

Exemples de requêtes

http(s)://ros.aliyuncs.com/?Action=GetStack
&StackId=c754d2a4-28f1-46df-b557-9586173a****
&RegionId=cn-hangzhou
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<GetStackResponse>
    <Status>CREATE_COMPLETE</Status>
    <Description>Create a VPC.</Description>
    <Parameters>
        <ParameterKey>ALIYUN::Region</ParameterKey>
        <ParameterValue>cn-hangzhou</ParameterValue>
    </Parameters>
    <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>
    <StatusReason>Stack CREATE completed successfully</StatusReason>
    <ParentStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</ParentStackId>
    <CreateTime>2020-09-16T08:21:40</CreateTime>
    <DeletionProtection>Disabled</DeletionProtection>
    <RootStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</RootStackId>
    <TemplateDescription>Create a VPC.</TemplateDescription>
    <StackType>ROS</StackType>
    <RamRoleName>test-role</RamRoleName>
    <UpdateTime>2020-09-17T08:21:40</UpdateTime>
    <Outputs/>
    <DriftDetectionTime>2020-09-16T09:21:40</DriftDetectionTime>
    <RegionId>cn-hangzhou</RegionId>
    <StackDriftStatus>IN_SYNC</StackDriftStatus>
    <NotificationURLs>["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"]</NotificationURLs>
    <DisableRollback>false</DisableRollback>
    <StackName>MyStack</StackName>
    <Tags>
        <Key>usage</Key>
        <Value>test</Value>
    </Tags>
    <TimeoutInMinutes>10</TimeoutInMinutes>
    <StackId>c754d2a4-28f1-46df-b557-9586173a****</StackId>
    <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
    <ResourceProgress>
        <TotalResourceCount>2</TotalResourceCount>
        <SuccessResourceCount>1</SuccessResourceCount>
        <FailedResourceCount>0</FailedResourceCount>
        <InProgressResourceCount>1</InProgressResourceCount>
        <PendingResourceCount>0</PendingResourceCount>
        <InProgressResourceDetails>
            <ResourceName>WaitCondition</ResourceName>
            <ResourceType>ALIYUN::ROS::WaitCondition</ResourceType>
            <ProgressValue>5</ProgressValue>
            <ProgressTargetValue>10</ProgressTargetValue>
        </InProgressResourceDetails>
    </ResourceProgress>
    <Log>
        <TerraformLogs>
            <Command>apply</Command>
            <Stream>stdout</Stream>
            <Content>Apply complete! Resources: 42 added, 0 changed, 0 destroyed.</Content>
        </TerraformLogs>
        <ResourceLogs>
            <ResourceName>MyResourceCleaner</ResourceName>
            <Logs>
                <Keys>ResourceDetails</Keys>
                <Content>[]</Content>
            </Logs>
        </ResourceLogs>
    </Log>
    <TemplateId>a52f81be-496f-4e1c-a286-8852ab54****</TemplateId>
    <TemplateVersion>v1</TemplateVersion>
    <TemplateScratchId>ts-7f7a704cf71c49a6****</TemplateScratchId>
    <TemplateURL>oss://ros/template/demo</TemplateURL>
    <Interface>{}</Interface>
    <ServiceManaged>false</ServiceManaged>
    <ServiceName>ACVS</ServiceName>
    <OperationInfo>
        <Code>DependencyViolation</Code>
        <Message>There is still instance(s) in the specified security group.</Message>
        <RequestId>071D6166-3F6B-5C7B-A1F0-0113FBB643A8</RequestId>
        <Action>DeleteSecurityGroup</Action>
        <ResourceType>ALIYUN::ECS::SecurityGroup</ResourceType>
        <LogicalResourceId>EcsSecurityGroup</LogicalResourceId>
    </OperationInfo>
</GetStackResponse>

Format JSON

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

{
  "Status" : "CREATE_COMPLETE",
  "Description" : "Create a VPC.",
  "Parameters" : {
    "ParameterKey" : "ALIYUN::Region",
    "ParameterValue" : "cn-hangzhou"
  },
  "RequestId" : "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "StatusReason" : "Stack CREATE completed successfully",
  "ParentStackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
  "CreateTime" : "2020-09-16T08:21:40",
  "DeletionProtection" : "Disabled",
  "RootStackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
  "TemplateDescription" : "Create a VPC.",
  "StackType" : "ROS",
  "RamRoleName" : "test-role",
  "UpdateTime" : "2020-09-17T08:21:40",
  "Outputs" : "",
  "DriftDetectionTime" : "2020-09-16T09:21:40",
  "RegionId" : "cn-hangzhou",
  "StackDriftStatus" : "IN_SYNC",
  "NotificationURLs" : "[\"http://127.XX.XX.1:8080/x\", \"http://127.0.XX.XX:8080/y\"]",
  "DisableRollback" : false,
  "StackName" : "MyStack",
  "Tags" : {
    "Key" : "usage",
    "Value" : "test"
  },
  "TimeoutInMinutes" : 10,
  "StackId" : "c754d2a4-28f1-46df-b557-9586173a****",
  "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
  "ResourceProgress" : {
    "TotalResourceCount" : 2,
    "SuccessResourceCount" : 1,
    "FailedResourceCount" : 0,
    "InProgressResourceCount" : 1,
    "PendingResourceCount" : 0,
    "InProgressResourceDetails" : {
      "ResourceName" : "WaitCondition",
      "ResourceType" : "ALIYUN::ROS::WaitCondition",
      "ProgressValue" : 5,
      "ProgressTargetValue" : 10
    }
  },
  "Log" : {
    "TerraformLogs" : {
      "Command" : "apply",
      "Stream" : "stdout",
      "Content" : "Apply complete! Resources: 42 added, 0 changed, 0 destroyed."
    },
    "ResourceLogs" : {
      "ResourceName" : "MyResourceCleaner",
      "Logs" : {
        "Keys" : "ResourceDetails",
        "Content" : "[]"
      }
    }
  },
  "TemplateId" : "a52f81be-496f-4e1c-a286-8852ab54****",
  "TemplateVersion" : "v1",
  "TemplateScratchId" : "ts-7f7a704cf71c49a6****",
  "TemplateURL" : "oss://ros/template/demo",
  "Interface" : "{}",
  "ServiceManaged" : false,
  "ServiceName" : "ACVS",
  "OperationInfo" : {
    "Code" : "DependencyViolation",
    "Message" : "There is still instance(s) in the specified security group.",
    "RequestId" : "071D6166-3F6B-5C7B-A1F0-0113FBB643A8",
    "Action" : "DeleteSecurityGroup",
    "ResourceType" : "ALIYUN::ECS::SecurityGroup",
    "LogicalResourceId" : "EcsSecurityGroup"
  }
}

Codes d'erreur

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

HttpCode	Code d'erreur	Message d'erreur	Description
404	StackNotFound	The Stack ({name}) could not be found.	Le message d'erreur renvoyé car la pile spécifiée n'existe pas. name indique le nom ou l'ID de la pile.