GetTemplateSummary - - Centro de documentación de Alibaba Cloud

Consulta la información de una plantilla nueva o existente.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetTemplateSummary	Operación que desea ejecutar. Establezca el valor en GetTemplateSummary.
StackId	String	No	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID de la pila. Solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId y StackGroupName.
TemplateBody	String	No	{"ROSTemplateFormatVersion":"2015-09-01"}	Estructura que contiene el cuerpo de la plantilla. El cuerpo de la plantilla debe tener entre 1 y 524,288 bytes de longitud. Si la longitud del cuerpo supera el límite máximo, se recomienda agregar los parámetros al cuerpo de la solicitud HTTP POST. Esto evita errores por URL demasiado largas. Solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId y StackGroupName.
RegionId	String	No	cn-hangzhou	ID de la región a la que pertenece la pila o el grupo de pilas de la plantilla. Llame a la operación DescribeRegions para consultar la lista de regiones más reciente. Este parámetro solo surte efecto cuando se especifica StackId, ChangeSetId o StackGroupName.
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID de la plantilla. Este parámetro aplica tanto a plantillas compartidas como privadas. Solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId y StackGroupName.
TemplateURL	String	No	oss://ros/template/demo	URL del archivo que contiene el cuerpo de la plantilla. La URL debe apuntar a una plantilla alojada en un servidor web HTTP o HTTPS, o bien en un bucket de Object Storage Service (OSS) de Alibaba Cloud. Por ejemplo, oss://ros/template/demo u oss://ros/template/demo?RegionId=cn-hangzhou. El cuerpo de la plantilla puede tener hasta 524,288 bytes de longitud. Nota Si no especifica la región del bucket de OSS, se utiliza el valor del parámetro RegionId. Solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId y StackGroupName. La URL puede tener hasta 1,024 bytes de longitud.
ChangeSetId	String	No	1f6521a4-05af-4975-afe9-bc4b45ad****	ID del conjunto de cambios. Solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId y StackGroupName.
TemplateVersion	String	No	v1	Versión de la plantilla. Este parámetro surte efecto cuando se especifica TemplateId.
StackGroupName	String	No	my-stack-group	Nombre del grupo de pilas. Solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId y StackGroupName.
Parameters.N.ParameterKey	String	No	InstanceId	Nombre del parámetro N definido en la plantilla. Si no especifica el nombre ni el valor de un parámetro, Resource Orchestration Service (ROS) usa los valores predeterminados de la plantilla. Valor máximo de N: 200. Nota El parámetro Parameters es opcional. Si necesita especificarlo, indique tanto Parameters.N.ParameterKey como Parameters.N.ParameterValue.
Parameters.N.ParameterValue	String	No	i-rotp2e20whfrs2****	Valor del parámetro N definido en la plantilla. Valor máximo de N: 200. Nota El parámetro Parameters es opcional. Si necesita especificarlo, indique tanto Parameters.N.ParameterKey como Parameters.N.ParameterValue.
ClientToken	String	No	123e4567-e89b-12d3-a456-42665544****	Token de cliente que garantiza la idempotencia de la solicitud. Puede generar este valor desde el cliente, pero asegúrese de que sea único entre distintas solicitudes. El token puede tener hasta 64 caracteres y contener letras, dígitos, guiones (-) y guiones bajos (_). Para obtener más información, consulte Garantizar la idempotencia.

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
ResourceTypes	Array of String	["ALIYUN::ECS::VPC"]	Todos los tipos de recursos utilizados en la plantilla.
Description	String	No description	Descripción de la plantilla de la pila.
Parameters	Array of Object	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]	Declaraciones de los parámetros en la plantilla.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84B6E6	ID de la solicitud.
Version	String	2015-09-01	Versión de la plantilla.
Metadata	Map		Metadatos definidos en la plantilla.
ResourceIdentifierSummaries	Array of ResourceIdentifierSummary		Resúmenes de identificadores de recursos. Describen los recursos que desea importar y las propiedades utilizadas para identificarlos durante la importación. Por ejemplo, VpcId es una propiedad identificadora para los recursos ALIYUN::ECS::VPC.
ResourceType	String	ALIYUN::ECS::VPC	Tipo de recurso. Nota Puede importar recursos del tipo especificado en el parámetro ResouceType.
LogicalResourceIds	Array of String	["Vpc"]	ID lógicos de todos los recursos del tipo especificado en el parámetro ResouceType dentro de la plantilla.
ResourceIdentifiers	Array of String	["VpcId"]	Propiedades del recurso. Una propiedad de recurso permite identificar los recursos que desea gestionar. Por ejemplo, VpcId es una propiedad identificadora para los recursos ALIYUN::ECS::VPC.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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>

Formato JSON

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"
}

Códigos de error

Para consultar la lista de códigos de error, visite el centro de errores de API.

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	StackValidationFailed	{reason}.	Error devuelto porque no se pudo validar la pila. reason indica la causa del error.
404	ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	Error devuelto porque el conjunto de cambios no existe. name indica el nombre o ID del conjunto de cambios. stack indica el nombre o ID de la pila.
404	ChangeSetNotFound	The ChangeSet {ID} could not be found.	Error devuelto porque el conjunto de cambios no existe. ID indica el ID del conjunto de cambios.
404	StackNotFound	The Stack ({name}) could not be found.	Error devuelto porque la pila no existe. name indica el nombre o ID de la pila.
404	TemplateNotFound	The Tempalte ({ ID }) could not be found.	Error devuelto porque la plantilla no existe. ID indica el ID de la plantilla.
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	Error devuelto porque la plantilla o su versión especificada no existen. ID indica el ID de la plantilla. version indica la versión de la plantilla.