GetTemplateSummary - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetTemplateSummary	Operação a executar. Defina o valor como GetTemplateSummary.
StackId	String	Não	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID da pilha. Especifique apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.
TemplateBody	String	Não	{"ROSTemplateFormatVersion":"2015-09-01"}	Estrutura que contém o corpo do modelo, com tamanho entre 1 e 524.288 bytes. Caso o corpo do modelo exceda esse limite, adicione os parâmetros ao corpo da solicitação HTTP POST para evitar falhas causadas por URLs excessivamente longas. Especifique apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.
RegionId	String	Não	cn-hangzhou	ID da região à qual pertence a pilha ou o grupo de pilhas do modelo. Chame a operação DescribeRegions para consultar a lista de regiões mais recente. Este parâmetro só tem efeito ao especificar StackId, ChangeSetId ou StackGroupName.
TemplateId	String	Não	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID do modelo. Aplica-se a modelos compartilhados e privados. Especifique apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.
TemplateURL	String	Não	oss://ros/template/demo	URL do arquivo que contém o corpo do modelo. Deve apontar para um modelo hospedado em um servidor web HTTP/HTTPS ou em um bucket do Alibaba Cloud Object Storage Service (OSS), como oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. O corpo do modelo pode ter até 524.288 bytes. Nota Se a região do bucket OSS não for especificada, o sistema usará o valor do parâmetro RegionId. Especifique apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName. A URL pode ter até 1.024 bytes.
ChangeSetId	String	Não	1f6521a4-05af-4975-afe9-bc4b45ad****	ID do conjunto de alterações. Especifique apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.
TemplateVersion	String	Não	v1	Versão do modelo. Este parâmetro entra em vigor ao especificar TemplateId.
StackGroupName	String	Não	my-stack-group	Nome do grupo de pilhas. Especifique apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.
Parameters.N.ParameterKey	String	Não	InstanceId	Nome do parâmetro N definido no modelo. Se o nome e o valor não forem especificados, o Resource Orchestration Service (ROS) usará os valores padrão do modelo. Valor máximo de N: 200. Nota O parâmetro Parameters é opcional. Para utilizá-lo, defina tanto Parameters.N.ParameterKey quanto Parameters.N.ParameterValue.
Parameters.N.ParameterValue	String	Não	i-rotp2e20whfrs2****	Valor do parâmetro N definido no modelo. Valor máximo de N: 200. Nota O parâmetro Parameters é opcional. Para utilizá-lo, defina tanto Parameters.N.ParameterKey quanto Parameters.N.ParameterValue.
ClientToken	String	Não	123e4567-e89b-12d3-a456-42665544****	Token de cliente usado para garantir a idempotência da solicitação. Gere o valor pelo cliente, assegurando que seja único entre solicitações diferentes. O token aceita até 64 caracteres, incluindo letras, dígitos, hifens (-) e sublinhados (_). Para mais informações, consulte Garantir idempotência.

Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
ResourceTypes	Array of String	["ALIYUN::ECS::VPC"]	Todos os tipos de recursos utilizados no modelo.
Description	String	No description	Descrição do modelo de pilha.
Parameters	Array of Object	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]	Declarações dos parâmetros no modelo.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84B6E6	ID da solicitação.
Version	String	2015-09-01	Versão do modelo.
Metadata	Map		Metadados definidos no modelo.
ResourceIdentifierSummaries	Array of ResourceIdentifierSummary		Resumos de identificadores de recursos que descrevem os recursos a importar e as propriedades usadas para identificação durante a importação. Por exemplo, VpcId é uma propriedade identificadora para recursos ALIYUN::ECS::VPC.
ResourceType	String	ALIYUN::ECS::VPC	Tipo de recurso. Nota É possível importar recursos do tipo especificado pelo parâmetro ResouceType.
LogicalResourceIds	Array of String	["Vpc"]	IDs lógicos de todos os recursos do tipo especificado pelo parâmetro ResouceType no modelo.
ResourceIdentifiers	Array of String	["VpcId"]	Propriedades do recurso. Utilize-as para identificar os recursos a gerenciar. Por exemplo, VpcId é uma propriedade identificadora para recursos ALIYUN::ECS::VPC.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o API Error Center.

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	StackValidationFailed	{reason}.	Mensagem retornada quando a validação da pilha falha. reason indica a causa do erro.
404	ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	Mensagem retornada quando o conjunto de alterações não existe. name indica o nome ou ID do conjunto de alterações. stack indica o nome ou ID da pilha.
404	ChangeSetNotFound	The ChangeSet {ID} could not be found.	Mensagem retornada quando o conjunto de alterações não existe. ID indica o ID do conjunto de alterações.
404	StackNotFound	The Stack ({name}) could not be found.	Mensagem retornada quando a pilha não existe. name indica o nome ou ID da pilha.
404	TemplateNotFound	The Tempalte ({ ID }) could not be found.	Mensagem retornada quando o modelo não existe. ID indica o ID do modelo.
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	Mensagem retornada quando o modelo ou a versão especificada não existe. ID indica o ID do modelo. version indica a versão do modelo.