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

Consulta os detalhes de um modelo ao especificar uma stack, um grupo de stacks, um conjunto de alterações ou um modelo personalizado.

Descrição da operação

Este tópico fornece um exemplo de como consultar os detalhes de um modelo cujo ID é 5ecd1e10-b0e9-4389-a565-e4c15efc**** na região cn-hangzhou.

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

get

stack.

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

modelo.

acs:ros:*:{#accountId}:template/{#templateId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StackId	string	Não	O ID da stack. Nota Você deve especificar apenas um dos seguintes parâmetros: StackId, ChangeSetId, StackGroupName e TemplateId.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	Não	O ID da região da stack ou do grupo de stacks ao qual o modelo pertence. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ChangeSetId	string	Não	O ID do conjunto de alterações. Nota Você deve especificar apenas um dos seguintes parâmetros: StackId, ChangeSetId, StackGroupName e TemplateId.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateId	string	Não	O ID do modelo. Modelos compartilhados e privados são suportados. Para um modelo compartilhado, o TemplateId é o mesmo que o TemplateARN. Use este valor para a consulta. Nota Você deve especificar apenas um dos seguintes parâmetros: StackId, ChangeSetId, StackGroupName e TemplateId.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	Não	A versão do modelo. Este parâmetro só entra em vigor quando TemplateId é especificado. Para um modelo compartilhado, este parâmetro é suportado apenas quando VersionOption está definido como AllVersions. Para mais informações, consulte SetTemplatePermission. Valores válidos: v1 a v65000 e Draft. Valores válidos para modelos compartilhados: v1 a v65000.	v1
TemplateStage	string	Não	O estágio do modelo. Este parâmetro só entra em vigor quando StackId, ChangeSetId ou StackGroupName é especificado. Valores válidos: Processed: o modelo analisado e transformado. Este é o valor padrão. Original: o modelo original especificado pelo usuário.	Processed
IncludePermission	string	Não	Especifica se deve consultar as informações de compartilhamento do modelo. Valores válidos: Enabled: consulta as informações de compartilhamento. Disabled: não consulta as informações de compartilhamento. Este é o valor padrão. Nota Apenas o proprietário do modelo pode consultar as informações de compartilhamento.	Enabled
StackGroupName	string	Não	O nome do grupo de stacks. Nota Você deve especificar apenas um dos seguintes parâmetros: StackId, ChangeSetId, StackGroupName e TemplateId.	MyStackGroup
IncludeTags	string	Não	Especifica se deve consultar as informações de tags. Valores válidos: Enabled: consulta as informações de tags. Disabled: não consulta as informações de tags. Este é o valor padrão. Nota Este parâmetro só entra em vigor quando TemplateId é especificado.	Enabled

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TemplateARN	string	O ARN do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
Description	string	A descrição do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado.	ROS template for create ECS instance.
RequestId	string	O ID da solicitação.	B288A0BE-D927-4888-B0F7-B35EF84****
CreateTime	string	A hora em que o modelo foi criado. A hora é exibida no formato AAAA-MM-DDThh:mm:ss. Este parâmetro é retornado apenas quando TemplateId é especificado. Nota Se TemplateVersion for especificado, a hora de criação do modelo da versão especificada será retornada. Se TemplateVersion não for especificado, a hora de criação do modelo da versão padrão será retornada.	2020-11-18T08:49:26
StackGroupName	string	O nome do grupo de stacks. Este parâmetro é retornado apenas quando StackGroupName é especificado.	MyStackGroup
TemplateVersion	string	A versão do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado. Se TemplateVersion não for especificado ou não entrar em vigor, este parâmetro indica a versão atual do modelo. Para um modelo compartilhado, este parâmetro é retornado apenas quando VersionOption está definido como AllVersions.	v1
TemplateBody	string	O conteúdo do modelo.	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetId	string	O ID do conjunto de alterações. Este parâmetro é retornado apenas quando ChangeSetId é especificado.	e85abe0c-6528-43fb-ae93-fdf8de22****
OwnerId	string	O ID da conta Alibaba Cloud ao qual o modelo pertence. Este parâmetro é retornado apenas quando TemplateId é especificado.	151266687691****
UpdateTime	string	A hora em que o modelo foi atualizado pela última vez. A hora é exibida no formato AAAA-MM-DDThh:mm:ss. Este parâmetro é retornado apenas quando TemplateId é especificado. Nota Se TemplateVersion for especificado, a hora da última atualização do modelo da versão especificada será retornada. Se TemplateVersion não for especificado, a hora da última atualização do modelo será retornada.	2020-12-07T06:11:48
Permissions	array<object>	O status de compartilhamento do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado e IncludePermission está definido como Enabled. Nota Se TemplateVersion não for especificado ou não entrar em vigor, o status de compartilhamento do modelo será retornado. Se TemplateVersion for especificado e entrar em vigor, o status de compartilhamento do modelo associado à versão será retornado.
	object
VersionOption	string	A opção de versão compartilhada. Este parâmetro é retornado apenas quando ShareOption está definido como ShareToAccounts. Valores válidos: AllVersions: compartilha todas as versões do modelo compartilhado. Latest: compartilha apenas a versão mais recente do modelo compartilhado. Quando uma nova versão é adicionada ao modelo compartilhado, a versão compartilhada muda de acordo para permanecer sempre como a mais recente. Current: compartilha apenas a versão mais recente atual do modelo compartilhado. Quando uma nova versão é adicionada ao modelo compartilhado, a versão compartilhada permanece inalterada. Specified: compartilha apenas uma versão especificada do modelo compartilhado.	AllVersions
AccountId	string	A conta Alibaba Cloud com a qual o modelo é compartilhado.	142437958638****
ShareOption	string	A opção de compartilhamento. Valor válido: ShareToAccounts, que indica que o modelo é compartilhado com outras contas Alibaba Cloud.	ShareToAccounts
TemplateVersion	string	A versão do modelo compartilhado. Este parâmetro é retornado quando ShareOption está definido como ShareToAccounts e VersionOption está definido como Specified ou Current. Quando o parâmetro TemplateVersion está definido como Draft, se a versão Draft existir, Draft é retornado. Se a versão Draft não existir ou tiver sido excluída, a versão mais recente atual é retornada. Valores válidos: v1 a v65000 e Draft.	v1
ShareSource	string	A origem do relacionamento de compartilhamento. Valores válidos: ROS: o relacionamento de compartilhamento é estabelecido usando o console ou a API do ROS. ResourceDirectory: o relacionamento de compartilhamento é estabelecido para contas em um diretório de recursos usando o recurso de compartilhamento de recursos no Resource Management. Nota O compartilhamento do ROS e o compartilhamento do Resource Directory têm cotas independentes. O compartilhamento do Resource Directory não pode ser cancelado ou substituído usando o console ou a API do ROS. O compartilhamento do Resource Directory pode substituir o compartilhamento do ROS.	ROS
TemplateName	string	O nome do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado. Nota Se TemplateVersion for especificado, o nome do modelo associado à versão será retornado. Se TemplateVersion não for especificado, o nome do modelo será retornado.	MyTemplate
RegionId	string	O ID da região da stack ou do grupo de stacks ao qual o modelo pertence. Este parâmetro é retornado apenas quando StackId, ChangeSetId ou StackGroupName é especificado.	cn-hangzhou
TemplateId	string	O ID do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado. Para um modelo compartilhado, o valor retornado é o mesmo que o TemplateARN.	a52f81be-496f-4e1c-a286-8852ab54****
StackId	string	O ID da stack. Este parâmetro é retornado apenas quando StackId é especificado.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ShareType	string	O tipo de compartilhamento do modelo. Este parâmetro é retornado apenas quando TemplateId é especificado. Valores válidos: Private: o modelo pertence ao usuário. Shared: o modelo é compartilhado por outro usuário.	Private
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxazb4ph6aiy****
Interface	string	A descrição da interface.	{}
Tags	array<object>	As tags do modelo.
	object	As tags do modelo.
Key	string	A chave da tag do modelo.	usage
Value	string	O valor da tag do modelo.	test
AdditionalInfo	object	As informações suplementares do modelo público.	{"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["Other"]},"Provider":"ROS","Categories":["Solution"]}

Exemplos

Resposta de sucesso

JSON formato

{
  "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description": "ROS template for create ECS instance.",
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84****",
  "CreateTime": "2020-11-18T08:49:26",
  "StackGroupName": "MyStackGroup",
  "TemplateVersion": "v1",
  "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
  "OwnerId": "151266687691****",
  "UpdateTime": "2020-12-07T06:11:48",
  "Permissions": [
    {
      "VersionOption": "AllVersions",
      "AccountId": "142437958638****",
      "ShareOption": "ShareToAccounts",
      "TemplateVersion": "v1",
      "ShareSource": "ROS"
    }
  ],
  "TemplateName": "MyTemplate",
  "RegionId": "cn-hangzhou",
  "TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
  "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****\t",
  "ShareType": "Private",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Interface": "{}",
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "AdditionalInfo": {
    "DeploymentDuration": null,
    "Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
    "Labels": {
      "ResourceTypes": [
        "ALIYUN::ECS::Instance",
        "ALIYUN::ECS::SecurityGroup",
        "ALIYUN::ECS::VPC",
        "ALIYUN::ECS::VSwitch",
        "ALIYUN::OSS::Bucket",
        "ALIYUN::ROS::WaitCondition",
        "ALIYUN::ROS::WaitConditionHandle"
      ],
      "DeployTypes": [
        "ROS"
      ],
      "ApplicationScenes": [
        "其他"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

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.