GetTemplateSummary - - Centre de documentation Alibaba Cloud

Débogage

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

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	GetTemplateSummary	Opération à effectuer. Définissez la valeur sur GetTemplateSummary.
StackId	String	No	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID de la pile. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.
TemplateBody	String	No	{"ROSTemplateFormatVersion":"2015-09-01"}	Structure contenant le corps du modèle. La taille du corps du modèle doit être comprise entre 1 et 524 288 octets. Si la taille 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 afin d'éviter les échecs de requête causés par des URL excessivement longues. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.
RegionId	String	No	cn-hangzhou	ID de la région à laquelle appartient la pile ou le groupe de piles défini dans le modèle. Appelez l'opération DescribeRegions pour interroger la liste des régions les plus récentes. Ce paramètre prend effet uniquement lorsque vous spécifiez le paramètre StackId, ChangeSetId ou StackGroupName.
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID 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.
TemplateURL	String	No	oss://ros/template/demo	URL du fichier contenant le corps du modèle. L'URL doit pointer vers un modèle situé sur un serveur web HTTP ou HTTPS ou dans un bucket Alibaba Cloud Object Storage Service (OSS), tel que oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. La taille du corps du modèle peut atteindre 524 288 octets. Remarque Si vous ne spécifiez pas la région du bucket OSS, la valeur du paramètre RegionId est utilisée. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName. La longueur de l'URL peut atteindre 1 024 octets.
ChangeSetId	String	No	1f6521a4-05af-4975-afe9-bc4b45ad****	ID de l'ensemble de modifications. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.
TemplateVersion	String	No	v1	Version du modèle. Ce paramètre prend effet lorsque vous spécifiez le paramètre TemplateId.
StackGroupName	String	No	my-stack-group	Nom du groupe de piles. Vous ne pouvez spécifier qu'un seul des paramètres suivants : TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId et StackGroupName.
Parameters.N.ParameterKey	String	No	InstanceId	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 devez spécifier Parameters, vous devez indiquer à la fois Parameters.N.ParameterKey et Parameters.N.ParameterValue.
Parameters.N.ParameterValue	String	No	i-rotp2e20whfrs2****	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 devez spécifier Parameters, vous devez indiquer à la fois Parameters.N.ParameterKey et Parameters.N.ParameterValue.
ClientToken	String	No	123e4567-e89b-12d3-a456-42665544****	Jeton client utilisé pour garantir l'idempotence de la requête. Générez la valeur à l'aide du client, mais assurez-vous qu'elle est unique pour chaque requête. Le jeton peut contenir jusqu'à 64 caractères, y compris des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). Pour plus d'informations, consultez Assurer l'idempotence.

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
ResourceTypes	Array of String	["ALIYUN::ECS::VPC"]	Tous les types de ressources utilisés dans le modèle.
Description	String	No description	Description du modèle de pile.
Parameters	Array of Object	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]	Déclarations des paramètres dans le modèle.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84B6E6	ID de la requête.
Version	String	2015-09-01	Version du modèle.
Metadata	Map		Métadonnées définies dans le modèle.
ResourceIdentifierSummaries	Array of ResourceIdentifierSummary		Résumés des identifiants de ressources décrivant les ressources à importer ainsi que les propriétés utilisées pour identifier les ressources lors de l'importation. Par exemple, VpcId est une propriété d'identifiant pour les ressources ALIYUN::ECS::VPC.
ResourceType	String	ALIYUN::ECS::VPC	Type de ressource. Remarque Vous pouvez importer des ressources du type spécifié par le paramètre ResouceType.
LogicalResourceIds	Array of String	["Vpc"]	IDs logiques de toutes les ressources du type spécifié par le paramètre ResouceType dans le modèle.
ResourceIdentifiers	Array of String	["VpcId"]	Propriétés de la ressource. Utilisez une propriété de ressource pour identifier les ressources à gérer. Par exemple, VpcId est une propriété d'identifiant pour les ressources ALIYUN::ECS::VPC.

Exemples

Exemple de requête

http(s)://ros.aliyuncs.com/?Action=GetTemplateSummary
&StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691****
&RegionId=cn-hangzhou
&<Common request parameters>

Exemple de réponse réussie

XML format

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

<GetTemplateSummary>
		<Description>No description</Description>
		<Metadata />
		<Parameters>
			<Description>Description of the vpc, [2, 256] characters. Do not fill or empty, the default is empty.</Description>
			<Label>Description</Label>
			<NoEcho>false</NoEcho>
			<ParameterKey>Description</ParameterKey>
			<Type>String</Type>
		</Parameters>
		<Parameters>
			<Description>Tags to attach to vpc. Max support 20 tags to add during create vpc. Each tag with two properties Key and Value, and Key is required.</Description>
			<Label>Tags</Label>
			<MaxLength>20</MaxLength>
			<NoEcho>false</NoEcho>
			<ParameterKey>Tags</ParameterKey>
			<Type>Json</Type>
		</Parameters>
		<Parameters>
			<Description>IPv6 network cidr of the VPC.</Description>
			<Label>Ipv6CidrBlock</Label>
			<MinLength>1</MinLength>
			<NoEcho>false</NoEcho>
			<ParameterKey>Ipv6CidrBlock</ParameterKey>
			<Type>String</Type>
		</Parameters>
		<Parameters>
			<AllowedValues>True</AllowedValues>
			<AllowedValues>true</AllowedValues>
			<AllowedValues>False</AllowedValues>
			<AllowedValues>false</AllowedValues>
			<Default>false</Default>
			<Description>Whether to enable an IPv6 network cidr, the value is:False (default): not turned on.True: On.</Description>
			<Label>EnableIpv6</Label>
			<NoEcho>false</NoEcho>
			<ParameterKey>EnableIpv6</ParameterKey>
			<Type>Boolean</Type>
		</Parameters>
		<Parameters>
			<Description>Resource group id.</Description>
			<Label>ResourceGroupId</Label>
			<NoEcho>false</NoEcho>
			<ParameterKey>ResourceGroupId</ParameterKey>
			<Type>String</Type>
		</Parameters>
		<Parameters>
			<Description>Display name of the vpc instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'</Description>
			<Label>VpcName</Label>
			<NoEcho>false</NoEcho>
			<ParameterKey>VpcName</ParameterKey>
			<Type>String</Type>
		</Parameters>
		<Parameters>
			<Description>
				The IP address range of the VPC in the CIDR block form. You can use the following IP address ranges and their subnets:
				10.0.0.0/8
				172.16.0.0/12 (Default)
			    192.168.0.0/16</Description>
			<Label>CidrBlock</Label>
			<NoEcho>false</NoEcho>
			<ParameterKey>CidrBlock</ParameterKey>
			<Type>String</Type>
		</Parameters>
		<RequestId>FD70598C-3F4B-4E66-9A76-67F2E2D36938</RequestId>
		<ResourceIdentifierSummaries>
			<LogicalResourceIds>Vpc</LogicalResourceIds>
			<ResourceIdentifiers>VpcId</ResourceIdentifiers>
			<ResourceType>ALIYUN::ECS::VPC</ResourceType>
		</ResourceIdentifierSummaries>
		<ResourceTypes>ALIYUN::ECS::VPC</ResourceTypes>
		<Version>2015-09-01</Version>
</GetTemplateSummary>

JSON format

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

{
  "Description" : "No description",
  "Metadata" : { },
  "Parameters" : [ {
    "Description" : "Description of the vpc, [2, 256] characters. Do not fill or empty, the default is empty.",
    "Label" : "Description",
    "NoEcho" : "false",
    "ParameterKey" : "Description",
    "Type" : "String"
  }, {
    "Description" : "Tags to attach to vpc. Max support 20 tags to add during create vpc. Each tag with two properties Key and Value, and Key is required.",
    "Label" : "Tags",
    "MaxLength" : 20,
    "NoEcho" : "false",
    "ParameterKey" : "Tags",
    "Type" : "Json"
  }, {
    "Description" : "IPv6 network cidr of the VPC.",
    "Label" : "Ipv6CidrBlock",
    "MinLength" : 1,
    "NoEcho" : "false",
    "ParameterKey" : "Ipv6CidrBlock",
    "Type" : "String"
  }, {
    "AllowedValues" : [ "True", "true", "False", "false" ],
    "Default" : false,
    "Description" : "Whether to enable an IPv6 network cidr, the value is:False (default): not turned on.True: On.",
    "Label" : "EnableIpv6",
    "NoEcho" : "false",
    "ParameterKey" : "EnableIpv6",
    "Type" : "Boolean"
  }, {
    "Description" : "Resource group id.",
    "Label" : "ResourceGroupId",
    "NoEcho" : "false",
    "ParameterKey" : "ResourceGroupId",
    "Type" : "String"
  }, {
    "Description" : "Display name of the vpc instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'",
    "Label" : "VpcName",
    "NoEcho" : "false",
    "ParameterKey" : "VpcName",
    "Type" : "String"
  }, {
    "Description" : "The IP address range of the VPC in the CIDR block form. You can use the following IP address ranges and their subnets:\n10.0.0.0/8\n172.16.0.0/12 (Default)\n192.168.0.0/16",
    "Label" : "CidrBlock",
    "NoEcho" : "false",
    "ParameterKey" : "CidrBlock",
    "Type" : "String"
  } ],
  "RequestId" : "FD70598C-3F4B-4E66-9A76-67F2E2D36938",
  "ResourceIdentifierSummaries" : [ {
    "LogicalResourceIds" : [ "Vpc" ],
    "ResourceIdentifiers" : [ "VpcId" ],
    "ResourceType" : "ALIYUN::ECS::VPC"
  } ],
  "ResourceTypes" : [ "ALIYUN::ECS::VPC" ],
  "Version" : "2015-09-01"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.

HTTP status code	Error code	Error message	Description
400	StackValidationFailed	{reason}.	Message d'erreur indiquant que la validation de la pile a échoué. reason indique la cause de l'erreur.
404	ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	Message d'erreur indiquant que l'ensemble de modifications n'existe pas. name indique le nom ou l'ID de l'ensemble de modifications. stack indique le nom ou l'ID de la pile.
404	ChangeSetNotFound	The ChangeSet {ID} could not be found.	Message d'erreur indiquant que l'ensemble de modifications n'existe pas. ID indique l'ID de l'ensemble de modifications.
404	StackNotFound	The Stack ({name}) could not be found.	Message d'erreur indiquant que la pile n'existe pas. name indique le nom ou l'ID de la pile.
404	TemplateNotFound	The Tempalte ({ ID }) could not be found.	Message d'erreur indiquant que le modèle n'existe pas. ID indique l'ID du modèle.
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	Message d'erreur indiquant que le modèle ou la version spécifiée du modèle n'existe pas. ID indique l'ID du modèle. version indique la version du modèle.