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

Descrição da operação

Neste exemplo, um modelo é gerado para um cenário de gerenciamento de recursos localizado na região da China (Hangzhou). O ID do cenário de recursos é ts-aa9c62feab844a6b****.

Nota

Você não pode gerar um modelo para um cenário de detecção de recursos.

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

list

*TemplateScratch

acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do cenário de recursos. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
TemplateScratchId	string	Sim	O ID do cenário de recursos. Para obter mais informações sobre como consultar os IDs dos cenários de recursos, consulte ListTemplateScratches.	ts-aa9c62feab844a6b****
ProvisionRegionId	string	Não	O ID da região do novo nó.	cn-hangzhou
TemplateType	string	Não	O tipo de modelo que o Resource Orchestration Service (ROS) gera. O ROS pode gerar modelos dos tipos ROS e Terraform. Valor padrão: ROS.	ROS

Para obter mais informações sobre os parâmetros de solicitação comuns, consulte Referência da API.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
TemplateBody	string	O conteúdo do modelo do cenário de recursos.	{\"ROSTemplateFormatVersion\": \"2015-09-01\", \"Resources\": {\"ECSVPC_001\": {\"DeletionPolicy\": \"Retain\", \"Type\": \"ALIYUN::ECS::VPC\", \"Properties\": {\"CidrBlock\": \"172.16.0.0/12\", \"VpcName\": \"MyTestVpc\", \"EnableIpv6\": false}}}}
ResourcesToImport	array<object>	Os recursos que você deseja importar para uma pilha no cenário de gerenciamento de recursos. Nota Este parâmetro é retornado apenas para um cenário de gerenciamento de recursos.
	array<object>
ResourceType	string	O tipo do recurso.	ALIYUN::ECS::VPC
LogicalResourceId	string	O ID lógico do recurso.	ECSVPC_001
ResourceIdentifier	object	O mapeamento de chave-valor entre strings. O valor é uma string JSON que identifica o recurso que você deseja importar para uma pilha. Uma chave é um identificador para um recurso, e um valor é uma atribuição de dados à chave. Por exemplo, VpcId é uma chave que indica o ID de uma nuvem privada virtual (VPC), e `vpc-bp1m6fww66xbntjyc****` é um valor atribuído a VpcId.	{"VpcId": "vpc-bp1m6fww66xbntjyc****" }

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D22C1D13-D74E-558C-AF68-1B4C05FA6F1A",
  "TemplateBody": "{\\\"ROSTemplateFormatVersion\\\": \\\"2015-09-01\\\", \\\"Resources\\\": {\\\"ECSVPC_001\\\": {\\\"DeletionPolicy\\\": \\\"Retain\\\", \\\"Type\\\": \\\"ALIYUN::ECS::VPC\\\", \\\"Properties\\\": {\\\"CidrBlock\\\": \\\"172.16.0.0/12\\\", \\\"VpcName\\\": \\\"MyTestVpc\\\", \\\"EnableIpv6\\\": false}}}}",
  "ResourcesToImport": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceId": "ECSVPC_001",
      "ResourceIdentifier": {
        "VpcId": "vpc-bp1m6fww66xbntjyc****"
      }
    }
  ]
}

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.