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

Cria um cenário de recursos.

Descrição da operação

Limites

Apenas tipos de recursos específicos suportam o recurso de cenário de recursos. Para obter mais informações, consulte Tipos de recursos que suportam cenários.

Descrição

O Resource Orchestration Service (ROS) fornece o recurso de cenário de recursos. Você pode selecionar um escopo de recursos na interface do usuário e realizar operações como replicação ou gerenciamento de um grupo de recursos, ajudando a simplificar o gerenciamento de recursos. Para obter mais informações sobre cenários de recursos, consulte Visão geral.

Cenário de replicação de recursos

Se você deseja replicar uma coleção de recursos e dependências entre os recursos, pode criar um cenário de replicação de recursos. Esse tipo de cenário permite replicar todos os recursos existentes dentro do escopo especificado e gerar uma coleção de recursos que possuem a mesma arquitetura dos recursos existentes. Para obter mais informações, consulte Cenário de replicação de recursos.

Cenário de detecção de recursos

Se as relações entre os recursos que você deseja criar forem complexas, você pode criar um cenário de detecção de recursos para visualizar a arquitetura geral de recursos ou a arquitetura a partir de um recurso específico. Isso ajuda a simplificar o gerenciamento de recursos. Para obter mais informações, consulte Cenário de detecção de recursos.

Cenário de gerenciamento de recursos

Se você precisa importar uma coleção de recursos existentes para uma nova pilha de recursos para gerenciamento unificado, pode criar um cenário de gerenciamento de recursos. Para obter mais informações, consulte Cenário de gerenciamento de recursos.

Cenário de migração de recursos

Se você deseja migrar uma coleção de recursos e dependências entre os recursos, pode criar um cenário de migração de recursos. Ao migrar os recursos, o ROS gera uma pilha. Você pode visualizar o progresso da migração na guia Pilhas da página de detalhes do cenário. Após migrar os recursos, você pode excluir os recursos de origem. Para obter mais informações, consulte Cenário de migração de recursos.

Este tópico fornece um exemplo de como criar um cenário de replicação de recursos na região China (Hangzhou) para replicar uma nuvem privada virtual (VPC) com o ID vpc-bp1m6fww66xbntjyc****.

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

create

*TemplateScratch

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

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 DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
TemplateScratchType	string	Sim	O tipo do cenário de recursos. Valores válidos: ArchitectureReplication: replicação de recursos ArchitectureDetection: detecção de recursos ResourceImport: gerenciamento de recursos ResourceMigration: migração de recursos Nota Ao especificar valores diferentes para o parâmetro TemplateScratchType, os parâmetros opcionais na descrição suplementar dos parâmetros de solicitação também são diferentes. Para obter mais informações, consulte a seção Descrição suplementar dos parâmetros de solicitação abaixo.	ArchitectureReplication
Description	string	Não	A descrição do cenário de recursos.	Copy VPC resources.
SourceResources	array<object>	Não	Os recursos de origem. Ao definir TemplateScratchType como ArchitectureDetection, você pode especificar SourceResources para detectar os dados de arquitetura de todos os recursos associados aos recursos de origem especificados. Por exemplo, se você especificar um ID de instância CLB, o sistema detectará e identificará seus recursos associados, como instâncias ECS, vSwitches e VPCs. Se TemplateScratchType estiver definido como ArchitectureDetection, você pode especificar até 20 recursos de origem. Em outros casos, há suporte para até 200 recursos de origem.
	object	Não	O recurso de origem.
ResourceId	string	Sim	O ID do recurso.	vpc-bp1m6fww66xbntjyc****
ResourceType	string	Sim	O tipo de recurso.	ALIYUN::ECS::VPC
RegionId	string	Não	O ID da região do recurso. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente. Nota Este parâmetro só entra em vigor quando TemplateScratchType está definido como ArchitectureDetection. O ID da região de um recurso global é `global`. Por exemplo, ALIYUN::CDN::Domain é um recurso global e seu ID de região é `global`.	cn-beijing
RelatedResourceTypeFilter	array	Não	Os filtros de tipo de recurso relacionado.
	string	Não	O filtro de tipo de recurso relacionado.	ALIYUN::ECS::VPC
SourceTag	object	Não	As tags de origem.
ResourceTags	object	Sim	As tags de origem que consistem em pares chave-valor. Se você deseja especificar apenas uma chave de tag, defina o valor da tag como uma string vazia, por exemplo: `{"TagKey": ""}`. Você pode adicionar até 10 tags de origem. Se você definir TemplateScratchType como ArchitectureDetection, poderá adicionar até 5 tags de origem.	{"a": "b"}
ResourceTypeFilter	array	Não	O filtro de tipos de recurso.
	string	Não	O filtro para tipos de recurso. Se uma lista de tipos de recurso for especificada, apenas os recursos dos tipos especificados que contêm as tags especificadas serão verificados. Se não for especificado, todos os recursos que contêm as tags especificadas serão verificados. Você pode especificar até 20 tipos de recurso.	ALIYUN::ECS::VPC
SourceResourceGroup	object	Não	O grupo de recursos de origem.
ResourceGroupId	string	Sim	O ID do grupo de recursos de origem.	rg-acfmzawhxxc****
ResourceTypeFilter	array	Não	Os tipos de recurso para filtragem de recursos.
	string	Não	O filtro para tipos de recurso. Se uma lista de tipos de recurso for especificada, apenas os recursos dos tipos especificados que contêm as tags especificadas serão verificados. Se não for especificado, todos os recursos que contêm as tags especificadas serão verificados. Você pode especificar até 20 tipos de recurso.	ALIYUN::ECS::VPC
PreferenceParameters	array<object>	Não	Parâmetros de configuração para o cenário de recursos.
	object	Não
ParameterKey	string	Sim	A chave do parâmetro. Para obter mais informações sobre os valores válidos, consulte a seção Descrição suplementar dos parâmetros de solicitação neste tópico. Nota PreferenceParameters é opcional. Se você especificar PreferenceParameters, deverá especificar ParameterKey e ParameterValue. Você deve definir ParameterKey como DeletionPolicy quando TemplateScratchType estiver definido como ResourceImport.	DeletionPolicy
ParameterValue	string	Sim	O valor do parâmetro. O valor é uma atribuição ao ParameterKey. Para obter mais informações sobre os valores válidos, consulte a seção Descrição suplementar dos parâmetros de solicitação neste tópico. Nota PreferenceParameters é opcional. Se você especificar PreferenceParameters, deverá especificar ParameterKey e ParameterValue.	Retain
LogicalIdStrategy	string	Não	A estratégia de geração de ID lógico. Valores válidos: LongTypePrefixAndIndexSuffix: prefixo do tipo longo + sufixo do tipo índice LongTypePrefixAndHashSuffix: prefixo do tipo longo + sufixo do tipo hash ShortTypePrefixAndHashSuffix: prefixo do tipo curto + sufixo do tipo hash Nota Valor padrão: LongTypePrefixAndIndexSuffix. Se TemplateScratchType estiver definido como ArchitectureDetection, o valor padrão é LongTypePrefixAndHashSuffix.	LongTypePrefixAndIndexSuffix
ClientToken	string	Não	Garante a idempotência da solicitação. Este valor deve ser gerado pelo cliente e deve ser globalmente único. Deve ter no máximo 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_). Para obter mais informações, consulte Como garantir a idempotência.	123e4567-e89b-12d3-a456-42665544****
ExecutionMode	string	Não	O modo de execução. Valores válidos: Async (padrão): modo assíncrono Sync: modo síncrono Nota Se o escopo de recursos for grande, a execução síncrona levará muito tempo. Recomendamos que você especifique ClientToken para evitar problemas de tempo limite.	Sync
Tags	array<object>	Não	As tags do cenário de recursos.
	object	Não
Key	string	Sim	A chave da tag N que você deseja adicionar ao cenário de recursos. Nota Tags é opcional. Se você especificar Tags, deverá especificar Tags.N.Key.	usage
Value	string	Não	O valor da tag N que você deseja adicionar ao cenário de recursos.	test
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual você deseja atribuir a política de snapshot. Se você deixar este parâmetro vazio, o cenário de recursos será adicionado ao grupo de recursos padrão.	rg-acfmxazb4ph6aiy****

Notas adicionais sobre os parâmetros de solicitação

Para obter mais informações, consulte Parâmetros comuns.

Ao especificar valores diferentes para o parâmetro TemplateScratchType, os valores válidos de ParameterKey e ParameterValue também diferem.

Cenário de replicação de recursos

A tabela a seguir descreve os valores válidos de ParameterKey e ParameterValue quando você define TemplateScratchType como ArchitectureReplication.

ParameterKey	ParameterValue
DeletionPolicy	A política de exclusão de recursos. Valores válidos: Retain: retém recursos quando você exclui a pilha para a qual os recursos são replicados. Delete: exclui recursos por padrão quando você exclui a pilha para a qual os recursos são replicados. Se você reter recursos específicos quando a caixa de diálogo Excluir Pilha aparecer, os recursos serão retidos.
RegionId	O ID da região de destino para a qual você deseja replicar recursos. Se você não especificar uma região de destino, a região atual será usada por padrão. Exemplo: cn-shanghai.
ZoneId	O ID da zona de destino para a qual você deseja replicar recursos. Se você replicar recursos na mesma região e não especificar uma zona de destino, a zona dos recursos de origem será usada para os recursos replicados. Se você replicar recursos entre regiões e não especificar uma zona de destino, o sistema filtrará as zonas suportadas por todos os recursos. Exemplo: cn-shanghai-b.
VpcId	O ID da VPC de destino para a qual você deseja replicar recursos. Se você replicar recursos na mesma região e não especificar uma VPC de destino, a VPC dos recursos de origem será usada para os recursos replicados. Se você replicar recursos entre regiões e não especificar uma VPC de destino, o sistema criará automaticamente uma VPC na região de destino. Exemplo: vpc-bp1hye0s8b69xokfu****.
VSwitchId	O ID do vSwitch de destino para o qual você deseja replicar recursos. Se você replicar recursos na mesma região e não especificar um vSwitch de destino, o vSwitch dos recursos de origem será usado para os recursos replicados. Se você replicar recursos entre regiões e não especificar um vSwitch de destino, o sistema criará automaticamente um vSwitch na região de destino. Exemplo: vsw-bp11ufkwqwggtm1cj****.
NamePrefix	O prefixo do nome do recurso. Por padrão, o nome de um recurso não contém um prefixo. O prefixo deve ter de 2 a 32 caracteres.
DisableNameUnique	Especifica se deve desativar a aplicação automática da exclusividade de nome. Por padrão, está ativada. Para recursos que têm o recurso ativado, como o recurso Bucket, códigos aleatórios de oito caracteres são anexados automaticamente aos nomes dos recursos para garantir a exclusividade de nome dos recursos replicados.
InstanceDataReplication	Especifica se deve replicar os dados da instância ECS. Valor padrão: false. Valores válidos:* true: replica os dados da instância ECS. Se você replicar os dados na mesma região, uma imagem personalizada será criada para a instância de origem e novas instâncias serão criadas com base na imagem personalizada. Se você replicar os dados entre regiões, uma imagem personalizada será criada para a instância de origem e replicada para a região de destino. Novas instâncias serão criadas com base na imagem personalizada.

false: não replica os dados da instância ECS. | | InstancePeriod | A duração da assinatura da instância ECS por assinatura de destino. Por padrão, a duração da assinatura da instância de origem é usada. | | InstancePeriodUnit | A unidade da duração da assinatura da instância ECS por assinatura de destino. Por padrão, a unidade de duração da assinatura da instância de origem é usada. Valores válidos:* Week
Month
Year | | InstanceAmount | O número de instâncias ECS a serem replicadas. Este parâmetro só entra em vigor quando o recurso de origem é uma única instância ECS. | | RamAttachedPolicyReplication | Especifica se deve replicar a política do RAM associada a usuários, grupos de usuários e funções do RAM. Valor padrão: false. Valores válidos:* true
false | | AlbLoadBalancerEdition | A edição da instância ALB. Os recursos e as regras de cobrança variam de acordo com a edição. Valores válidos:* Basic: Edição Básica
Standard: Edição Padrão
StandardWithWaf: Edição com Web Application Firewall (WAF) ativadoExemplo: Standard. | | AlbAddressType | O tipo de endereço da instância ALB. Valores válidos:* Internet: A instância ALB possui um endereço IP público. O nome de domínio do Domain Name System (DNS) é resolvido para o endereço IP público. Portanto, a instância ALB pode ser acessada pela Internet.
Intranet: A instância ALB possui apenas um endereço IP privado. O nome de domínio do DNS é resolvido para o endereço IP privado. Portanto, a instância ALB só pode ser acessada dentro da VPC onde a instância ALB está implantada.Exemplo: Internet. | | AlbAddressIpVersion | A versão do IP. Valores válidos:* IPv4: IPv4
DualStack: pilha duplaExemplo: IPv4. | | AlbZoneMappings | Os mapeamentos entre zonas e vSwitches. Você pode especificar no máximo 10 zonas. Se a região selecionada suportar duas ou mais zonas, selecione pelo menos duas zonas para garantir a alta disponibilidade do seu serviço. O valor é uma string JSON que possui a mesma estrutura do parâmetro ZoneMappings na operação CreateLoadBalancer do ALB. Exemplo: [{"ZoneId": "cn-bejing-g": "VSwitchId": "vsw-gersdf****"}, {"ZoneId": "cn-bejing-f": "VSwitchId": "vsw-fersdf****"}] | | SlbListenerProtocols | O protocolo do listener de uma instância CLB. Especifica os protocolos de listener a serem incluídos na replicação. Você pode definir um ou mais protocolos, separados por vírgulas. Por padrão, nenhuma restrição é aplicada. Valores válidos:* tcp
udp
http
httpsExemplo: tcp,udp. |

Nota

Ao definir ParameterKey como InstanceDataReplication e ParameterValue como true, pare a instância de origem antes de replicar os recursos para garantir a consistência dos dados.

Cenário de detecção de recursos

A tabela a seguir descreve os valores válidos de ParameterKey e ParameterValue quando você define TemplateScratchType como ArchitectureDetection.

ParameterKey	ParameterValue
RegionIds	Um ou mais IDs de região. Separe vários IDs de região com vírgulas (,). A região global `global` é suportada. Se você não especificar uma região, a região do cenário será usada.

Cenário de gerenciamento de recursos

A tabela a seguir descreve os valores válidos de ParameterKey e ParameterValue quando você define TemplateScratchType como ResourceImport.

Nota

Para um cenário de gerenciamento de recursos, você deve definir ParameterKey como DeletionPolicy.

ParameterKey	ParameterValue
DeletionPolicy	A política de exclusão de recursos. Valores válidos: Retain: retém recursos quando você exclui a pilha que usa para gerenciar os recursos. Delete: exclui recursos por padrão quando você exclui a pilha que usa para gerenciar os recursos. Se você reter recursos específicos quando a caixa de diálogo Excluir Pilha aparecer, os recursos serão retidos.
SlbListenerProtocols	O protocolo do listener de uma instância CLB. Especifica os protocolos de listener a serem incluídos no gerenciamento. Você pode definir um ou mais protocolos, separados por vírgulas. Por padrão, nenhuma restrição é aplicada. Valores válidos: Valores válidos:* tcp

udp
http
httpsExemplo: tcp,udp. |

Cenário de migração de recursos

A tabela a seguir descreve os valores válidos de ParameterKey e ParameterValue quando você define TemplateScratchType como ResourceMigration.

ParameterKey	ParameterValue
RegionId	O ID da região de destino para a qual você deseja migrar recursos. Se você não especificar uma região de destino, a região atual será usada por padrão. Exemplo: cn-shanghai.
ZoneId	O ID da zona de destino para a qual você deseja migrar recursos. Se você replicar recursos na mesma região e não especificar uma zona de destino, a zona dos recursos de origem será usada para os recursos replicados. Se você replicar recursos entre regiões e não especificar uma zona de destino, o sistema filtrará as zonas suportadas por todos os recursos. Exemplo: cn-shanghai-b.
VpcId	O ID da VPC de destino para a qual você deseja migrar recursos. Se você replicar recursos na mesma região e não especificar uma VPC de destino, a VPC dos recursos de origem será usada para os recursos replicados. Se você replicar recursos entre regiões e não especificar uma VPC de destino, o sistema criará automaticamente uma VPC na região de destino. Exemplo: vpc-bp1hye0s8b69xokfu****.
VSwitchId	O ID do vSwitch de destino para o qual você deseja migrar recursos. Se você replicar recursos na mesma região e não especificar um vSwitch de destino, o vSwitch dos recursos de origem será usado para os recursos replicados. Se você replicar recursos entre regiões e não especificar um vSwitch de destino, o sistema criará automaticamente um vSwitch na região de destino. Exemplo: vsw-bp11ufkwqwggtm1cj****.
InstanceDataReplication	Especifica se deve migrar os dados da instância ECS. Valores válidos: true: migra os dados da instância ECS. Se você migrar os dados na mesma região, uma imagem personalizada será criada para a instância de origem e novas instâncias serão criadas com base na imagem personalizada. Se você migrar os dados entre regiões, uma imagem personalizada será criada para a instância de origem e replicada para a região de destino. Novas instâncias serão criadas com base na imagem personalizada. false: não migra os dados da instância ECS.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	84980977-22F0-5421-B30D-B201311D5DCF
TemplateScratchId	string	O ID do cenário de recursos.	ts-7f7a704cf71c49a6****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****"
}

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.