Consulte les informations de la pile.
Description de l'opération
Cette rubrique fournit un exemple montrant comment consulter les informations d'une pile dont l'identifiant est c754d2a4-28f1-46df-b557-9586173a**** dans la région 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
|
ros:GetStack |
get |
*stack
|
Aucune | Aucune |
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| StackId |
string |
Oui |
L'identifiant de la pile. |
c754d2a4-28f1-46df-b557-9586173a**** |
| RegionId |
string |
Oui |
L'identifiant de la région de la pile. Vous pouvez appeler DescribeRegions pour consulter la liste la plus récente des régions. |
cn-hangzhou |
| ClientToken |
string |
Non |
Le jeton client utilisé pour garantir l'idempotence de la requête. Le jeton est généré par le client et doit être globalement unique. \nLe jeton peut comporter jusqu'à 64 caractères. \nPour plus d'informations, consultez Comment garantir l'idempotence. |
123e4567-e89b-12d3-a456-42665544**** |
| OutputOption |
string |
Non |
Indique si le paramètre Outputs (la liste des sorties de la pile) doit être renvoyé. Valeurs valides :
Remarque
Le calcul des Outputs est chronophage. Si vous n'avez pas besoin des informations Outputs, définissez OutputOption sur Disabled pour améliorer la vitesse de réponse de l'API. |
Disabled |
| ShowResourceProgress |
string |
Non |
Indique si le paramètre ResourceProgress (progression du traitement des ressources) doit être renvoyé. Valeurs valides :
Remarque
Les piles ROS et les piles Terraform sont toutes deux prises en charge. La création de pile (y compris la reprise de la création), la mise à jour, la suppression, l'importation de ressources et les opérations de restauration correspondantes sont prises en charge.
Remarque
Lors de la création de la pile, l'état de la pile est CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, CREATE_ROLLBACK_IN_PROGRESS, CREATE_ROLLBACK_COMPLETE ou CREATE_ROLLBACK_FAILED. |
Disabled |
| LogOption |
string |
Non |
L'option de journalisation. Valeurs valides :\n- None : ne retourne aucun journal.\n- Stack (par défaut) : retourne les journaux liés à la pile.\n- Resource : retourne les journaux liés aux ressources.\n- All : retourne tous les journaux. |
Stack |
Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
|||
| Status |
string |
L'état de la pile. Valeurs valides :
|
CREATE_COMPLETE |
| Description |
string |
La description de la pile. |
Créer un VPC |
| Parameters |
array<object> |
Les paramètres de la pile. |
|
|
object |
|||
| ParameterKey |
string |
Le nom du paramètre. |
ALIYUN::Region |
| ParameterValue |
string |
La valeur du paramètre. |
cn-hangzhou |
| RequestId |
string |
L'identifiant de la requête. |
B288A0BE-D927-4888-B0F7-B35EF84B6E6F |
| StatusReason |
string |
La raison pour laquelle la pile se trouve dans son état actuel. |
Création de la pile terminée avec succès |
| ParentStackId |
string |
L'identifiant de la pile parente. |
4a6c9851-3b0f-4f5f-b4ca-a14bf692**** |
| CreateTime |
string |
L'heure de création de la pile. L'heure est affichée en UTC+0 et suit la norme ISO 8601 sans le Z final. Format : AAAA-MM-JJThh:mm:ss. |
2020-09-16T08:21:40 |
| DeletionProtection |
string |
Indique si la protection contre la suppression est activée pour la pile. Valeurs valides :
Remarque
Le mécanisme de protection contre la suppression d'une pile imbriquée est le même que celui de la pile racine. |
Disabled |
| RootStackId |
string |
L'identifiant de la pile racine. Ce paramètre n'est renvoyé que lorsque la pile est une pile imbriquée. |
4a6c9851-3b0f-4f5f-b4ca-a14bf692**** |
| TemplateDescription |
string |
La description du modèle. |
Créer un VPC |
| StackType |
string |
Le type de pile. Valeurs valides :
|
ROS |
| RamRoleName |
string |
Le nom du rôle RAM. Resource Orchestration Service (ROS) endosse ce rôle pour créer la pile et appelle des opérations d'API au nom de l'utilisateur en utilisant les informations d'identification du rôle. ROS utilise toujours ce rôle pour toutes les opérations effectuées sur la pile. Tant que l'utilisateur dispose de l'autorisation d'effectuer des opérations sur la pile, ROS utilise ce rôle même si l'utilisateur n'a pas l'autorisation d'utiliser le rôle. Cela garantit que le rôle accorde le moindre privilège. Si aucune valeur n'est spécifiée, ROS utilise le rôle précédemment associé à la pile. Si aucun rôle n'est disponible, ROS utilise des informations d'identification temporaires générées à partir des informations d'identification de l'utilisateur. Le nom du rôle RAM peut comporter jusqu'à 64 octets. |
test-role |
| UpdateTime |
string |
L'heure de la dernière mise à jour de la pile. L'heure est affichée en UTC+0 et suit la norme ISO 8601 sans le Z final. Format : AAAA-MM-JJThh:mm:ss. |
2020-09-17T08:21:40 |
| Outputs |
array<object> |
La liste des sorties de la pile. |
|
|
object |
La liste des sorties de pile. Remarque
Ce paramètre est renvoyé uniquement lorsque OutputOption est défini sur Enabled. |
[{"Description": "Identifiant du VPC","OutputKey": "VpcId","OutputValue": "vpc-bp1m6fww66xbntjyc****"}] |
|
| DriftDetectionTime |
string |
L'heure à laquelle la dernière détection de dérive réussie a été effectuée sur la pile. |
2020-09-16T09:21:40 |
| RegionId |
string |
L'identifiant de la région de la pile. Vous pouvez appeler DescribeRegions pour consulter la liste la plus récente des régions. |
cn-hangzhou |
| StackDriftStatus |
string |
L'état de dérive de la pile lors de la dernière détection de dérive réussie. Valeurs valides :\n- DRIFTED : la pile a dérivé.\n- NOT_CHECKED : aucune détection de dérive réussie n'a été effectuée sur la pile.\n- IN_SYNC : la pile est synchronisée. |
IN_SYNC |
| NotificationURLs |
array |
Les URL de rappel pour la réception des événements de la pile. |
|
|
string |
Les URL de rappel pour la réception des événements de la pile. |
["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"] |
|
| DisableRollback |
boolean |
Indique si la restauration est désactivée lorsque la création de la pile échoue. Valeurs valides :
|
false |
| StackName |
string |
Le nom de la pile. 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 (_). |
MyStack |
| Tags |
array<object> |
Les balises de la pile. |
|
|
object |
|||
| Key |
string |
La clé de balise de la pile. |
usage |
| Value |
string |
La valeur de balise de la pile. |
test |
| TimeoutInMinutes |
integer |
Le délai d'expiration pour la création de la pile. Unité : minutes. |
10 |
| StackId |
string |
L'identifiant de la pile. |
c754d2a4-28f1-46df-b557-9586173a**** |
| ResourceGroupId |
string |
L'identifiant du groupe de ressources. |
rg-acfmxazb4ph6aiy**** |
| ResourceProgress |
object |
La progression du traitement des ressources. |
|
| TotalResourceCount |
integer |
Le nombre total de ressources. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur EnabledIfCreateStack. |
2 |
| SuccessResourceCount |
integer |
Le nombre de ressources traitées avec succès. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur EnabledIfCreateStack. |
1 |
| FailedResourceCount |
integer |
Le nombre de ressources dont le traitement a échoué. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur EnabledIfCreateStack. |
0 |
| InProgressResourceCount |
integer |
Le nombre de ressources en cours de traitement. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur EnabledIfCreateStack. |
1 |
| PendingResourceCount |
integer |
Le nombre de ressources en attente de traitement. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur EnabledIfCreateStack. |
0 |
| InProgressResourceDetails |
array<object> |
La liste des détails de progression des ressources en cours de traitement. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur EnabledIfCreateStack. |
|
|
object |
Les détails de progression d'une ressource en cours de traitement. |
||
| ResourceName |
string |
The resource name. |
WaitCondition |
| ResourceType |
string |
The resource type. |
ALIYUN::ROS::WaitCondition |
| ProgressValue |
number |
The current progress value of the resource. |
5 |
| ProgressTargetValue |
number |
The target progress value of the resource. |
10 |
| StackOperationProgress |
number |
Le pourcentage de progression de l'opération de la pile. Plage de valeurs : 0 à 100. Exemple : lors de la création de la pile, la valeur commence à 0 et augmente. Si la création réussit, la valeur atteint 100. Si la création échoue et que la restauration commence, la valeur diminue. Lorsque la restauration réussit, la valeur atteint 0. Ce paramètre indique la progression globale de l'opération de création, quel que soit l'état de la pile, en cours de création ou de restauration. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur PercentageOnly. |
100 |
| StackActionProgress |
number |
Le pourcentage de progression de l'action de la pile. Plage de valeurs : de 0 à 100. Exemple : lors de la création de la pile, la valeur commence à 0 et augmente. Si la création réussit, la valeur atteint 100. Si la création échoue et qu'un retour en arrière commence, la valeur part d'une autre valeur (100 moins la valeur de progression au moment de l'échec de la création de la ressource) et augmente. Lorsque le retour en arrière réussit, la valeur atteint 100. Lors de la création de la pile, ce paramètre indique la progression de l'action de création. Lors du retour en arrière de la pile, ce paramètre indique la progression de l'action de retour en arrière. Remarque
Ce paramètre est renvoyé uniquement lorsque ShowResourceProgress est défini sur PercentageOnly. |
100 |
| Log |
object |
Les journaux de sortie liés à la pile. |
|
| TerraformLogs |
array<object> |
Les journaux de sortie Terraform. Ce paramètre est renvoyé uniquement pour les piles Terraform. Ce paramètre est renvoyé lorsque LogOption n'est pas spécifié, ou lorsque LogOption est défini sur Stack ou All. Remarque
Ce paramètre n'est pas renvoyé pour les piles en cours d'exécution. Ce paramètre indique les journaux de l'opération la plus récente (création, poursuite de la création, mise à jour ou suppression) sur la pile. |
|
|
object |
test. |
||
| Command |
string |
The name of the Terraform command that is run. Valid values:
For more information about the commands, see Command. |
apply |
| Stream |
string |
The output stream. Valid values:
|
stdout |
| Content |
string |
The content that is output by the current command in the current output stream. |
Apply complete! Resources: 42 added, 0 changed, 0 destroyed. |
| ResourceLogs |
array<object> |
Les journaux de sortie des ressources. Ce paramètre est renvoyé lorsque LogOption est défini sur Resource ou All. Remarque
Seuls certains types de ressources renvoient des journaux de ressources, tels que ALIYUN::ROS::ResourceCleaner. |
|
|
array<object> |
test. |
||
| ResourceName |
string |
The resource name defined in the template. |
MyResourceCleaner |
| Logs |
array<object> |
All logs associated with the resource. |
|
|
object |
test |
||
| Keys |
array |
The list of keywords for a log entry associated with the resource. |
|
|
string |
The keyword. |
ResourceDetails |
|
| Content |
string |
The content of a log entry associated with the resource. |
[] |
| TemplateId |
string |
L'identifiant du modèle. Ce paramètre est renvoyé uniquement lorsque le modèle utilisé par la pile est un modèle privé ou un modèle partagé. Si le modèle est un modèle partagé, la valeur renvoyée est identique au TemplateARN du modèle. |
a52f81be-496f-4e1c-a286-8852ab54**** |
| TemplateVersion |
string |
La version du modèle. Ce paramètre est renvoyé uniquement lorsque le modèle utilisé par la pile est un modèle privé ou un modèle partagé. Si le modèle est un modèle partagé, ce paramètre est renvoyé uniquement lorsque VersionOption est défini sur AllVersions lors du partage. Valeurs valides : v1 à v100. |
v1 |
| TemplateScratchId |
string |
L'identifiant du scénario de ressources. Ce paramètre n'est renvoyé que lorsque le modèle utilisé par la pile est généré à partir d'un scénario de ressources. |
ts-7f7a704cf71c49a6**** |
| TemplateURL |
string |
L'URL du fichier contenant le corps du modèle. Ce paramètre n'est renvoyé que lorsque le modèle utilisé par la pile provient d'une URL, y compris un serveur web (HTTP ou HTTPS) ou un compartiment OSS d'Alibaba Cloud. |
oss://ros/template/demo |
| Interface |
string |
La description de l'interface. |
{} |
| ServiceManaged |
boolean |
Indique si la pile est une pile gérée. Valeurs valides :
|
false |
| ServiceName |
string |
Le nom du service auquel la pile gérée appartient. |
ACVS |
| OperationInfo |
object |
Les informations supplémentaires renvoyées lorsqu'une erreur se produit pendant une opération de pile. Remarque
Cette propriété n'est renvoyée que dans des cas spécifiques et contient au moins une sous-propriété. Par exemple, une erreur se produit lors de l'appel à l'API d'un autre service cloud. |
|
| Code |
string |
Le code d'erreur. |
DependencyViolation |
| Message |
string |
Le message d'erreur. |
Il reste des instances dans le groupe de sécurité spécifié |
| RequestId |
string |
L'identifiant de la requête de l'appel d'API vers un autre service cloud. |
071D6166-3F6B-5C7B-A1F0-0113FBB643A8 |
| Action |
string |
Le nom de l'opération d'API appelée sur un autre service cloud. |
DeleteSecurityGroup |
| ResourceType |
string |
Le type de ressource sur lequel l'erreur d'opération s'est produite. |
ALIYUN::ECS::SecurityGroup |
| LogicalResourceId |
string |
L'identifiant logique de la ressource sur laquelle l'erreur d'opération s'est produite. |
EcsSecurityGroup |
| OrderIds |
array |
La liste des identifiants de commande. Ce paramètre n'est renvoyé que lorsque le paiement manuel des commandes d'abonnement est configuré lors de la création de la pile. |
|
|
string |
L'identifiant de la commande. |
2161413696**** |
|
| CheckedStackResourceCount |
integer |
Le nombre de ressources sur lesquelles une détection de dérive a été effectuée. Remarque
Ce paramètre est renvoyé uniquement lorsque la détection de dérive la plus récente sur la pile a réussi. |
1 |
| NotCheckedStackResourceCount |
integer |
Le nombre de ressources sur lesquelles la détection de dérive n'a pas été effectuée.\n> Ce paramètre est renvoyé uniquement lorsque la dernière détection de dérive sur la pile a réussi. |
1 |
| RollbackFailedRootReason |
string |
Lorsque l'état de la pile est un échec de retour arrière, ce champ affiche la cause racine de l'échec dans la phase précédente qui a déclenché le retour arrière. |
Resource UPDATE failed: Exception: resources.FailToCreate: FailToCreate: reason |
Exemples
JSON format
{
"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": [
[
{
"Description": "VPC ID",
"OutputKey": "VpcId",
"OutputValue": "vpc-bp1m6fww66xbntjyc****"
}
]
],
"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
}
],
"StackOperationProgress": 100,
"StackActionProgress": 100
},
"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"
},
"OrderIds": [
"2161413696****"
],
"CheckedStackResourceCount": 1,
"NotCheckedStackResourceCount": 1,
"RollbackFailedRootReason": "Resource UPDATE failed: Exception: resources.FailToCreate: FailToCreate: reason"
}
Codes d'erreur
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.