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

Obtém os detalhes de um cenário de recursos.

Descrição da operação

Este tópico fornece um exemplo de como consultar os detalhes do cenário de recursos ts-7f7a704cf71c49a6**** na região da China (Hangzhou) e exibir os dados do nó de origem.

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

get

*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 DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
TemplateScratchId	string	Não	O ID do cenário de recursos.	ts-7f7a704cf71c49a6****
ShowDataOption	string	Não	A opção de exibição de dados. Valores válidos: Sources: exibe apenas os dados do nó de origem. Este valor é aplicável quando TemplateScratchType está definido como ArchitectureDetection. Source: exibe apenas os dados do nó de origem. Este valor é aplicável quando TemplateScratchType não está definido como ArchitectureDetection. Provisions: exibe apenas os dados do novo nó. Este valor é aplicável quando TemplateScratchType não está definido como ArchitectureDetection. All: exibe todos os dados. Para obter mais informações sobre nós de origem e novos nós, consulte Visão geral. Nota Se você não especificar este parâmetro, os dados do nó não serão exibidos por padrão.	Source

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
TemplateScratch	object	O cenário de recursos.
TemplateScratchId	string	O ID do cenário de recursos.	ts-7f7a704cf71c49a6****
TemplateScratchType	string	O tipo do cenário de recursos. Valores válidos: ResourceImport: gerenciamento de recursos. ArchitectureReplication: replicação de recursos.	ArchitectureReplication
Status	string	O status do cenário de recursos. Valores válidos: GENERATE_IN_PROGRESS: sendo gerado. GENERATE_COMPLETE: gerado. GENERATE_FAILED: falha na geração.	GENERATE_COMPLETE
StatusReason	string	O motivo da falha na geração do cenário de recursos. Nota Este parâmetro é retornado apenas quando Status está definido como GENERATE_FAILED.	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
FailedCode	string	O código de status que indica o motivo da falha na geração do cenário de recursos. Nota Este parâmetro é retornado apenas quando Status está definido como GENERATE_FAILED.	InvalidZoneId
TemplateScratchData	object	Os dados do cenário de recursos.	参见返回示例
PreferenceParameters	array<object>	Os parâmetros de configuração do cenário de recursos.
	object
ParameterKey	string	The parameter name.	DeletionPolicy
ParameterValue	string	The parameter value.	Retain
Description	string	A descrição do cenário de recursos.	复制VPC资源。
SourceResources	array<object>	Os recursos de origem.
	object	Os recursos de origem.
ResourceId	string	The resource ID.	vpc-m5e7cv7e9mz69sszb****
ResourceType	string	The resource type.	ALIYUN::ECS::VPC
RelatedResourceTypeFilter	array	The filter for related resource types.
	string	The filter for related resource types.	ALIYUN::ECS::VPC
SourceTag	object	A tag de origem.
ResourceTags	object	The source tag.	{"a": "b"}
ResourceTypeFilter	array	The resource type filter.
	string	The resource type filter.	ALIYUN::ECS::VPC
SourceResourceGroup	object	O grupo de recursos de origem.
ResourceGroupId	string	The ID of the source resource group.	rg-acfmzawhxxc****
ResourceTypeFilter	array	The resource type filter.
	string	The resource type filter.	ALIYUN::ECS::VPC
LogicalIdStrategy	string	A estratégia de geração de ID lógico. Valores válidos: LongTypePrefixAndIndexSuffix (padrão): prefixo de tipo longo com sufixo de índice. LongTypePrefixAndHashSuffix: prefixo de tipo longo com sufixo de hash. ShortTypePrefixAndHashSuffix: prefixo de tipo curto com sufixo de hash.	LongTypePrefixAndIndexSuffix
CreateTime	string	A hora em que o cenário de recursos foi criado. A hora é exibida em UTC+0 e segue o padrão ISO 8601 sem o Z no final. Formato: YYYY-MM-DDThh:mm:ss.	2021-12-22T01:49:22
UpdateTime	string	A hora em que o cenário de recursos foi atualizado pela última vez. A hora é exibida em UTC+0 e segue o padrão ISO 8601 sem o Z no final. Formato: YYYY-MM-DDThh:mm:ss.	2021-12-22T01:49:23
Stacks	array<object>	A lista de stacks associadas ao cenário de recursos.
	object
StackId	string	The stack ID.	3708bf6a-3a67-44d4-9eb1-c56704b9****
RegionId	string	The region ID of the stack.	cn-hangzhou
UsageType	string	The purpose of the stack. Valid values: ResourceImport: resource management. ArchitectureReplication: resource replication.	ArchitectureReplication
StackProvision	object	As informações de provisionamento da stack.
Creatable	boolean	Indicates whether you can call CreateStack to create a stack for resource replication. Valid values: true: Supported. false: Not supported.	true
Importable	boolean	Indicates whether you can call CreateChangeSet to create a change set for resource management. Valid values: true: Supported. false: Not supported.	false
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzmhzoaad5oq

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A8E0EF98-6FBD-5656-8298-FC8194F0F7B7",
  "TemplateScratch": {
    "TemplateScratchId": "ts-7f7a704cf71c49a6****",
    "TemplateScratchType": "ArchitectureReplication",
    "Status": "GENERATE_COMPLETE",
    "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
    "FailedCode": "InvalidZoneId",
    "TemplateScratchData": {
      "test": "test",
      "test2": 1
    },
    "PreferenceParameters": [
      {
        "ParameterKey": "DeletionPolicy",
        "ParameterValue": "Retain"
      }
    ],
    "Description": "复制VPC资源。",
    "SourceResources": [
      {
        "ResourceId": "vpc-m5e7cv7e9mz69sszb****",
        "ResourceType": "ALIYUN::ECS::VPC",
        "RelatedResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      }
    ],
    "SourceTag": {
      "ResourceTags": {
        "a": "b"
      },
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "SourceResourceGroup": {
      "ResourceGroupId": "rg-acfmzawhxxc****",
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
    "CreateTime": "2021-12-22T01:49:22",
    "UpdateTime": "2021-12-22T01:49:23",
    "Stacks": [
      {
        "StackId": "3708bf6a-3a67-44d4-9eb1-c56704b9****",
        "RegionId": "cn-hangzhou",
        "UsageType": "ArchitectureReplication"
      }
    ],
    "StackProvision": {
      "Creatable": true,
      "Importable": false
    },
    "ResourceGroupId": "rg-acfmzmhzoaad5oq"
  }
}

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.