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

Consulta as informações sobre um recurso de modelo usando o modelo, a pilha, o grupo de pilhas ou o conjunto de alterações correspondente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ros:GetTemplateSummary

get

Stack

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StackId	string	Não	O ID da pilha. Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	Não	A estrutura que contém o corpo do modelo. O corpo do modelo deve ter de 1 a 524.288 bytes de comprimento. Se o comprimento do corpo do modelo exceder o limite superior, recomendamos que você adicione parâmetros ao corpo da solicitação HTTP POST para evitar falhas de solicitação causadas por URLs excessivamente longas. Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	Não	O ID da região da pilha ou do grupo de pilhas que usa o modelo. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente. Este parâmetro só entra em vigor quando um dos seguintes parâmetros é especificado: StackId, ChangeSetId e StackGroupName.	cn-hangzhou
TemplateId	string	Não	O ID do modelo. Este parâmetro se aplica a modelos compartilhados e privados. Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	Não	A URL do arquivo que contém o corpo do modelo. A URL deve apontar para um modelo localizado em um servidor web HTTP ou HTTPS ou em um bucket do 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 de comprimento. Nota Se você não especificar o ID da região do bucket do OSS, o valor de RegionId será usado. Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName. A URL pode ter até 1.024 bytes de comprimento.	oss://ros/template/demo
ChangeSetId	string	Não	O ID do conjunto de alterações. Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	Não	A versão do modelo. Este parâmetro entra em vigor quando TemplateId é especificado.	v1
StackGroupName	string	Não	O nome do grupo de pilhas. Você pode especificar apenas um dos seguintes parâmetros: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId e StackGroupName.	my-stack-group
Parameters	array<object>	Não	Os parâmetros definidos no modelo.
	object	Não
ParameterKey	string	Não	O nome do parâmetro N definido no modelo. Se você não especificar o nome e o valor de um parâmetro, o Resource Orchestration Service (ROS) usará o nome e o valor padrão definidos no modelo. Valor máximo de N: 200. Nota O parâmetro Parameters é opcional. Se você especificar Parameters, deverá especificar tanto Parameters.N.ParameterKey quanto Parameters.N.ParameterValue.	InstanceId
ParameterValue	string	Não	O valor do parâmetro N definido no modelo. Valor máximo de N: 200. Nota O parâmetro Parameters é opcional. Se você especificar Parameters, deverá especificar tanto Parameters.N.ParameterKey quanto Parameters.N.ParameterValue.	i-rotp2e20whfrs2****
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode ter até 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_). Para mais informações, consulte Garantir idempotência.	123e4567-e89b-12d3-a456-42665544****

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ResourceTypes	array	Todos os tipos de recursos usados no modelo.
	string	O tipo de recurso usado no modelo.	["ALIYUN::ECS::VPC"]
Description	string	A descrição do modelo de pilha.	No description
Parameters	array<object>	As declarações dos parâmetros no modelo.
	object	A declaração do parâmetro no modelo.	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]
RequestId	string	O ID da solicitação.	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	A versão do modelo.	2015-09-01
Metadata	object	Os metadados definidos no modelo.	{"key": "value"}
ResourceIdentifierSummaries	array<object>	Os resumos de identificadores de recursos. Um resumo descreve o recurso que você deseja importar e as propriedades usadas para identificar o recurso durante a importação. Por exemplo, VpcId é uma propriedade identificadora de ALIYUN::ECS::VPC.
	object
ResourceType	string	O tipo de recurso. Nota A funcionalidade de importação de recursos é compatível com o tipo de recurso.	ALIYUN::ECS::VPC
LogicalResourceIds	array	Os IDs lógicos de todos os recursos do tipo especificado por ResouceType no modelo.
	string	O ID lógico do recurso do tipo especificado por ResouceType no modelo.	["Vpc"]
ResourceIdentifiers	array	As propriedades do recurso. Você pode usar uma propriedade de recurso para identificar o recurso que deseja gerenciar. Por exemplo, VpcId é uma propriedade identificadora de ALIYUN::ECS::VPC.
	string	A propriedade do recurso. Você pode usar uma propriedade de recurso para identificar o recurso que deseja gerenciar. Por exemplo, VpcId é uma propriedade identificadora de ALIYUN::ECS::VPC.	["VpcId"]

Exemplos

Resposta de sucesso

JSON formato

{
  "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\"]"
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.