Todos os produtos
Search

Este produto

    Resource Orchestration Service:UpdateTemplateScratch

    Central de documentação

    Resource Orchestration Service:UpdateTemplateScratch

    Última atualização: Jul 04, 2026

    Atualiza um cenário.

    Descrição da operação

    Cenário de replicação de recursos

    O Resource Orchestration Service (ROS) permite atualizar um cenário de replicação de recursos. As atualizações feitas em um cenário de replicação de recursos não afetam a stack gerada pelo cenário de recursos. Você pode chamar a operação GenerateTemplateByScratch para gerar um modelo para o cenário de recursos.

    Cenário de migração de recursos

    • Se você deseja atualizar um cenário de migração de recursos no qual os recursos de origem migrados são retidos, é possível excluir os recursos de origem para gerenciar o cenário de migração de recursos atualizado. Você também pode chamar a operação GenerateTemplateByScratch para gerar um modelo para o cenário de recursos.

      **

      Nota Certifique-se de que os recursos de origem que você deseja excluir de um cenário de migração de recursos estejam associados apenas ao cenário de recursos. Caso contrário, a exclusão dos recursos de origem falhará.

    • Se você deseja atualizar um cenário de migração de recursos no qual os recursos de origem migrados são excluídos, você só pode chamar a operação GenerateTemplateByScratch para gerar um modelo para o cenário de recursos.

    Cenário de gerenciamento de recursos

    Se você deseja atualizar um cenário de gerenciamento de recursos após usar o cenário de recursos para gerenciar recursos, você só pode chamar a operação GenerateTemplateByScratch para gerar um modelo para o cenário de recursos.

    Cenário de detecção de recursos

    Após atualizar um cenário de detecção de recursos, o ROS obtém os dados mais recentes do Resource Center e renderiza o diagrama de arquitetura.

    Este tópico fornece um exemplo de como atualizar um cenário de recursos. Neste exemplo, o ID de uma virtual private cloud (VPC) em um cenário de recursos cujo ID é ts-7f7a704cf71c49a6**** é atualizado para 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:UpdateTemplateScratch

    update

    *TemplateScratch

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

    		 Nenhuma 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.

    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.

    Os valores válidos dos parâmetros de solicitação ParameterKey e ParameterValue variam com base nos IDs de diferentes tipos de cenários de recursos. Para mais informações, consulte a seção "Informações adicionais sobre parâmetros de solicitação" deste tópico.

    Nota

    Você pode chamar a operação ListTemplateScratches para consultar o ID de um cenário de recursos.

    ts-7f7a704cf71c49a6****
    Description

    string

    Não

    A descrição do cenário.

    Copy VPC resources.
    SourceResources

    array<object>

    Não

    Os recursos de origem.

    Nota

    Você deve especificar apenas um dos seguintes parâmetros: SourceResources, SourceTag e SourceResourceGroup.

    object

    Não

    O recurso de origem.

    ResourceId

    string

    Sim

    O ID do recurso.

    vpc-bp1m6fww66xbntjyc****
    ResourceType

    string

    Sim

    O tipo do recurso.

    ALIYUN::ECS::VPC
    SourceTag

    object

    Não

    A tag de origem.

    Nota

    Você deve especificar apenas um dos seguintes parâmetros: SourceResources, SourceTag e SourceResourceGroup.

    ResourceTags

    object

    Sim

    As tags de origem. Uma tag contém uma chave de tag e um valor de tag.

    Se você deseja especificar apenas a chave de tag, deve deixar o valor de tag vazio. Exemplo: {"TagKey": ""}.

    Se você definir TemplateScratchType como ArchitectureDetection, poderá adicionar até 5 tags de origem. Em outros casos, poderá adicionar até 10 tags de origem.

    {"a": "b"}
    ResourceTypeFilter

    array

    Não

    Os tipos de recursos para filtragem de recursos.

    string

    Não

    O tipo de recurso para filtragem de recursos. Se você especificar os tipos de recursos, o ROS verificará apenas os recursos que são dos tipos especificados e possuem as tags especificadas. Se você não especificar os tipos de recursos, o ROS verificará todos os recursos que possuem as tags especificadas.

    Você pode especificar até 20 tipos de recursos.

    ALIYUN::ECS::VPC
    SourceResourceGroup

    object

    Não

    O grupo de recursos de origem.

    Nota

    Você deve especificar apenas um dos seguintes parâmetros: SourceResources, SourceTag e SourceResourceGroup.

    ResourceGroupId

    string

    Sim

    O ID do grupo de recursos de origem.

    rg-acfmzawhxxc****
    ResourceTypeFilter

    array

    Não

    Os tipos de recursos para filtragem de recursos.

    string

    Não

    O tipo de recurso para filtragem de recursos. Se você especificar os tipos de recursos, o ROS verificará apenas os recursos que são dos tipos especificados e pertencem ao grupo de recursos especificado. Se você não especificar os tipos de recursos, o ROS verificará todos os recursos que pertencem ao grupo de recursos especificado.

    Você pode especificar até 20 tipos de recursos.

    ALIYUN::ECS::VPC
    PreferenceParameters

    array<object>

    Não

    Os parâmetros de preferência do cenário de recursos.

    object

    Não

    O parâmetro de preferência do cenário.

    ParameterKey

    string

    Sim

    O nome do parâmetro.

    Para mais informações sobre os valores válidos de ParameterKey, consulte a seção "Informações adicionais sobre parâmetros de solicitação" deste tópico.

    Nota

    • PreferenceParameters é opcional. Se você especificar PreferenceParameters, deverá especificar tanto ParameterKey quanto ParameterValue.

    • Se você definir TemplateScratchType como ResourceImport, deverá definir ParameterKey como DeletionPolicy.

    DeletionPolicy
    ParameterValue

    string

    Sim

    O valor do parâmetro. O valor de ParameterValue varia com base no valor de ParameterKey.

    Para mais informações sobre os valores válidos de ParameterKey, consulte a seção "Informações adicionais sobre parâmetros de solicitação" deste tópico.

    Nota

    PreferenceParameters é opcional. Se você especificar PreferenceParameters, deverá especificar tanto ParameterKey quanto ParameterValue.

    Retain
    LogicalIdStrategy

    string

    Não

    A política com base na qual o ID lógico é gerado. Valores válidos:

    • LongTypePrefixAndIndexSuffix: prefixo de tipo longo + sufixo de tipo índice

    • LongTypePrefixAndHashSuffix: prefixo de tipo longo + sufixo de tipo hash

    • ShortTypePrefixAndHashSuffix: prefixo de tipo curto + sufixo de tipo hash

    Nota

    Se você definir TemplateScratchType como ArchitectureDetection, o valor padrão de LogicalIdStrategy será LongTypePrefixAndHashSuffix. Em outros casos, o valor padrão de LogicalIdStrategy será LongTypePrefixAndIndexSuffix.

    LongTypePrefixAndIndexSuffix
    ClientToken

    string

    Não

    O token do 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 único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres.

    Para 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)

    • Sync

    Nota

    Se você tiver um escopo amplo de recursos, Sync levará mais tempo. Se você definir ExecutionMode como Sync, recomendamos que especifique ClientToken para evitar o tempo limite de execução.

    Sync
    ResourceGroupId

    string

    Não

    O ID do grupo de recursos.

    rg-acfmxazb4ph6aiy****

    Informações adicionais sobre parâmetros de solicitação

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

    Os valores válidos dos parâmetros de solicitação ParameterKey e ParameterValue variam com base nos tipos de cenários de recursos.

    Cenário de replicação de recursos

    A tabela a seguir descreve os valores válidos dos parâmetros de solicitação ParameterKey e ParameterValue quando você define TemplateScratchId como o ID de um cenário de replicação de recursos.

    ParameterKeyParameterValue
    DeletionPolicyA política de exclusão para recursos. Valores válidos:Retain: retém os recursos quando você exclui a stack para a qual os recursos são replicados.Delete: exclui os recursos por padrão quando você exclui a stack para a qual os recursos são replicados. Se você reter recursos específicos quando a caixa de diálogo Excluir Stack aparecer, os recursos serão retidos.
    RegionIdO ID da região de destino para a qual você deseja replicar os recursos. Se você deixar este parâmetro vazio, a região dos recursos de origem será usada para os recursos replicados. Exemplo: cn-shanghai.
    ZoneIdO ID da zona de destino para a qual você deseja replicar os recursos. Se você replicar recursos na mesma região e deixar este parâmetro vazio, a zona dos recursos de origem será usada para os recursos replicados. Se você replicar recursos entre regiões e deixar este parâmetro vazio, o sistema filtrará as zonas suportadas por todos os recursos. Exemplo: cn-shanghai-b.
    VpcIdO ID da VPC de destino para a qual você deseja replicar os recursos. Se você replicar recursos na mesma região e deixar este parâmetro vazio, a VPC dos recursos de origem será usada para os recursos replicados. Se você replicar recursos entre regiões e deixar este parâmetro vazio, o sistema criará automaticamente uma VPC na região de destino. Exemplo: vpc-bp1hye0s8b69xokfu****.
    VSwitchIdO ID do vSwitch de destino para o qual você deseja replicar os recursos. Se você replicar recursos na mesma região e deixar este parâmetro vazio, o vSwitch dos recursos de origem será usado para os recursos replicados. Se você replicar recursos entre regiões e deixar este parâmetro vazio, o sistema criará automaticamente um vSwitch na região de destino. Exemplo: vsw-bp11ufkwqwggtm1cj****.
    InstanceDataReplicationEspecifica se os dados da instância Elastic Compute Service (ECS) devem ser replicados. Valores válidos:true: replica os dados da instância ECS. Se você replicar os dados na mesma região, o sistema criará uma imagem personalizada para a instância de origem e criará uma instância com base na imagem. Se você replicar os dados entre regiões, o sistema criará uma imagem personalizada para a instância de origem, replicará a imagem para a região de destino e, em seguida, criará uma instância com base na imagem.false: não replica os dados da instância ECS.

    Nota Se você definir ParameterKey como InstanceDataReplication e ParameterValue como true, recomendamos que replique os recursos após a instância de origem ser parada. Isso garante a consistência dos dados.

    Cenário de gerenciamento de recursos

    A tabela a seguir descreve os valores válidos dos parâmetros de solicitação ParameterKey e ParameterValue quando você define TemplateScratchId como o ID de um cenário de gerenciamento de recursos.

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

    ParameterKeyParameterValue
    DeletionPolicyA política de exclusão para recursos. Valores válidos:Retain: retém os recursos quando você exclui a stack usada para gerenciar os recursos.Delete: exclui os recursos por padrão quando você exclui a stack usada para gerenciar os recursos. Se você reter recursos específicos quando a caixa de diálogo Excluir Stack aparecer, os recursos serão retidos.

    Cenário de detecção de recursos

    A tabela a seguir descreve os valores válidos dos parâmetros de solicitação ParameterKey e ParameterValue quando você define TemplateScratchId como o ID de um cenário de detecção de recursos.

    ParameterKeyParameterValue
    RegionIdsUm ou mais IDs de região. Separe múltiplos IDs de região com vírgulas (,). Se você deixar este parâmetro vazio, a região do cenário de recursos será usada. Você não pode especificar RegionIds e SourceResources ao mesmo tempo.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

    221DA822-B8CF-50DF-A9D2-BA197BF97BD5
    TemplateScratchId

    string

    O ID do cenário.

    ts-7f7a704cf71c49a6****

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "221DA822-B8CF-50DF-A9D2-BA197BF97BD5",
  "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.