GetTemplateSummary - - Centre de documentation Alibaba Cloud

Consulte les informations relatives à une ressource de modèle en utilisant le modèle, la pile, le groupe de piles ou le jeu de modifications associé.

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:GetTemplateSummary

get

Stack

acs:ros:{#regionId}:{#accountId}:stack/{#StackId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
StackId	string	Non	L'identifiant de la pile. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	Non	La structure qui contient le corps du modèle. Le corps du modèle doit avoir une longueur de 1 à 524 288 octets. Si la longueur du corps du modèle dépasse la limite supérieure, nous vous recommandons d'ajouter des paramètres au corps de la requête HTTP POST pour éviter les échecs de requête causés par des URL trop longues. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	Non	L'identifiant de la région de la pile ou du groupe de piles qui utilise le modèle. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente. Ce paramètre ne prend effet que lorsque l'un des paramètres suivants est spécifié : StackId, ChangeSetId et StackGroupName.	cn-hangzhou
TemplateId	string	Non	L'identifiant du modèle. Ce paramètre s'applique aux modèles partagés et privés. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	Non	L'URL du fichier qui contient le corps du modèle. L'URL doit pointer vers un modèle situé sur un serveur web HTTP ou HTTPS ou dans un compartiment Object Storage Service (OSS), par exemple oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Le corps du modèle peut avoir une longueur maximale de 524 288 octets. Remarque Si vous ne spécifiez pas l'identifiant de la région du compartiment OSS, la valeur de RegionId est utilisée. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName. L'URL peut avoir une longueur maximale de 1 024 octets.	oss://ros/template/demo
ChangeSetId	string	Non	L'identifiant du jeu de modifications. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	Non	La version du modèle. Ce paramètre prend effet lorsque TemplateId est spécifié.	v1
StackGroupName	string	Non	Le nom du groupe de piles. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.	my-stack-group
Parameters	array<object>	Non	Les paramètres définis dans le modèle.
	object	Non
ParameterKey	string	Non	Le nom du paramètre N défini dans le modèle. Si vous ne spécifiez pas le nom et la valeur d'un paramètre, Resource Orchestration Service (ROS) utilise le nom et la valeur par défaut définis dans le modèle. Valeur maximale de N : 200. Remarque Le paramètre Parameters est facultatif. Si vous spécifiez Parameters, vous devez spécifier à la fois Parameters.N.ParameterKey et Parameters.N.ParameterValue.	InstanceId
ParameterValue	string	Non	La valeur du paramètre N défini dans le modèle. Valeur maximale de N : 200. Remarque Le paramètre Parameters est facultatif. Si vous spécifiez Parameters, vous devez spécifier à la fois Parameters.N.ParameterKey et Parameters.N.ParameterValue.	i-rotp2e20whfrs2****
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique pour chaque requête. Le jeton peut contenir jusqu'à 64 caractères et peut inclure des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). Pour plus d'informations, consultez Garantir l'idempotence.	123e4567-e89b-12d3-a456-42665544****

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
ResourceTypes	array	Tous les types de ressources utilisés dans le modèle.
	string	Le type de ressource utilisé dans le modèle.	["ALIYUN::ECS::VPC"]
Description	string	La description du modèle de pile.	Aucune description
Parameters	array<object>	Les déclarations des paramètres dans le modèle.
	object	La déclaration du paramètre dans le modèle.	[{"Description":"", "Label":"Nom", "NoEcho":"false", "ParameterKey":"Nom", "Type":"String"}]
RequestId	string	L'identifiant de la requête.	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	La version du modèle.	2015-09-01
Metadata	object	Les métadonnées définies dans le modèle.	{"clé": "valeur"}
ResourceIdentifierSummaries	array<object>	Les résumés des identifiants de ressources. Un résumé décrit la ressource que vous souhaitez importer et les propriétés utilisées pour identifier la ressource lors de l'importation. Par exemple, VpcId est une propriété d'identifiant de ALIYUN::ECS::VPC.
	object
ResourceType	string	Le type de ressource. Remarque La fonctionnalité d'importation de ressources est prise en charge pour ce type de ressource.	ALIYUN::ECS::VPC
LogicalResourceIds	array	Les identifiants logiques de toutes les ressources du type spécifié par ResouceType dans le modèle.
	string	L'identifiant logique de la ressource du type spécifié par ResouceType dans le modèle.	["Vpc"]
ResourceIdentifiers	array	Les propriétés de la ressource. Vous pouvez utiliser une propriété de ressource pour identifier la ressource que vous souhaitez gérer. Par exemple, VpcId est une propriété d'identifiant de ALIYUN::ECS::VPC.
	string	La propriété de la ressource. Vous pouvez utiliser une propriété de ressource pour identifier la ressource que vous souhaitez gérer. Par exemple, VpcId est une propriété d'identifiant de ALIYUN::ECS::VPC.	["VpcId"]

Exemples

JSON format

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::VPC\"]"
  ],
  "Description": "No description",
  "Parameters": [
    [
      {
        "Description": "",
        "Label": "Name",
        "NoEcho": "false",
        "ParameterKey": "Name",
        "Type": "String"
      }
    ]
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Version": "2015-09-01",
  "Metadata": {
    "key": "value"
  },
  "ResourceIdentifierSummaries": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceIds": [
        "[\"Vpc\"]"
      ],
      "ResourceIdentifiers": [
        "[\"VpcId\"]"
      ]
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.