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

Consulta uma lista de cenários de recursos.

Descrição da operação

Este tópico fornece um exemplo de como consultar a lista de cenários de recursos na região China (Hangzhou). A resposta mostra que existem dois cenários de recursos na região China (Hangzhou): gerenciamento de recursos e replicaçã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:ListTemplateScratches

get

*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
TemplateScratchId	string	Não	O ID do cenário de recursos.	ts-7f7a704cf71c49a6****
TemplateScratchType	string	Não	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.	ArchitectureReplication
Status	string	Não	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"]
Tags	array<object>	Não	As tags do cenário de recursos.
	object	Não
Key	string	Sim	A chave da tag do cenário de recursos. Nota O parâmetro Tags é opcional. Se você especificar Tags, deverá especificar Tags.N.Key.	usage
Value	string	Não	O valor da tag do cenário de recursos.	test
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Configurações para paginação. Valor máximo: 50. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página da lista de cenários de recursos. Valor inicial: 1. Valor padrão: 1.	1
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxazb4ph6aiy****

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.	D1C09606-C58B-558F-9B4E-5BF263D17D09
TotalCount	integer	O número total de cenários de recursos.	2
PageNumber	integer	O número da página da lista de cenários de recursos.	1
PageSize	integer	O número de entradas por página em uma consulta paginada. Configurações para paginação.	10
TemplateScratches	array<object>	Os cenários de recursos.
	array<object>
TemplateScratchId	string	O ID do cenário de recursos.	ts-48ad85d66cca4620****
TemplateScratchType	string	O tipo do cenário de recursos. Valores válidos: ResourceImport: gerenciamento de recursos. ArchitectureReplication: replicação de recursos.	ResourceImport
Status	string	O status do cenário de recursos.	GENERATE_COMPLETE
StatusReason	string	O motivo pelo qual a geração do cenário de recursos falhou. Nota Este parâmetro é retornado apenas se Status for 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 pelo qual a geração do cenário de recursos falhou. Valores válidos: InvalidZoneId: ID de zona inválido. IncorrectInstanceStatus: o status da instância não suporta esta operação. RecommendEmpty.DiskCategoryNotRecommended: a categoria do disco em nuvem não está disponível. Forbidden.RAM: permissões insuficientes do RAM. Nota Este parâmetro é retornado apenas se Status for GENERATE_FAILED. Essas informações são geradas com base em logs de chamadas e podem estar incompletas. Verifique as informações.	InvalidZoneId
PreferenceParameters	array<object>	Os parâmetros de configuração do cenário de recursos.
	object
ParameterKey	string	The parameter name. Valid values: AlbAddressIpVersion: the IP version of the ALB address. AlbAddressType: the ALB address type. AlbLoadBalancerEdition: the ALB load balancing edition. AlbZoneMappings: the ALB active zone mappings. RamAttachedPolicyReplication: RAM policy replication. DeletionPolicy: the delete policy. DisableNameUnique: specifies whether to disable name uniqueness. InstanceAmount: the number of instances. InstanceDataReplication: instance data replication. InstancePeriod: the instance epoch. InstancePeriodUnit: the instance epoch unit. NamePrefix: the name prefix. RamAttachedPolicyReplication: RAM attached policy replication. RegionId: the region ID. RegionIds: the list of region IDs. ResourceView: the resource view. ReuseStrategy: the reuse strategy. SlbListenerProtocols: the SLB listener protocols. TemplateType: the template type. VSwitchId: the vSwitch ID. VpcId: the VPC ID. ZoneId: the zone ID. This information is generated based on call logs and may be incomplete. Verify the information.	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
ResourceId	string	The resource ID.	vpc-m5eauuq80anx59v28****
ResourceType	string	The resource type. Valid values: ALIYUN::ALB::LoadBalancer: Application Load Balancer (ALB) for load balancing. ALIYUN::ECS::Instance: Elastic Compute Service (ECS) instance. ALIYUN::RAM::Role: RAM role. This information is generated based on call logs and may be incomplete. Verify the information.	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 source resource group ID.	rg-acfmzawhxxc****
ResourceTypeFilter	array	The resource type filter.
	string	The resource type filter. Valid values: ALIYUN::ECS::VPC: virtual private cloud (VPC). This information is generated based on call logs and may be incomplete. Verify the information.	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
Tags	array<object>	As tags do cenário de recursos.
	object
Key	string	The tag key of the resource scenario.	usage1
Value	string	The tag value of the resource scenario.	test1
CreateTime	string	O horário em que o cenário de recursos foi criado. O horário é exibido em UTC+0 e segue o padrão ISO 8601 sem o sufixo Z. Formato: AAAA-MM-DDThh:mm:ss.	2021-12-07T08:06:44
UpdateTime	string	O horário em que o cenário de recursos foi atualizado pela última vez. O horário é exibido em UTC+0 e segue o padrão ISO 8601 sem o sufixo Z. Formato: AAAA-MM-DDThh:mm:ss.	2021-12-07T08:06:44
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfm4nxcvht4pmi

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D1C09606-C58B-558F-9B4E-5BF263D17D09",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10,
  "TemplateScratches": [
    {
      "TemplateScratchId": "ts-48ad85d66cca4620****",
      "TemplateScratchType": "ResourceImport",
      "Status": "GENERATE_COMPLETE",
      "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
      "FailedCode": "InvalidZoneId",
      "PreferenceParameters": [
        {
          "ParameterKey": "DeletionPolicy",
          "ParameterValue": "Retain"
        }
      ],
      "Description": "纳管VPC资源。",
      "SourceResources": [
        {
          "ResourceId": "vpc-m5eauuq80anx59v28****",
          "ResourceType": "ALIYUN::ECS::VPC"
        }
      ],
      "SourceTag": {
        "ResourceTags": {
          "a": "b"
        },
        "ResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      },
      "SourceResourceGroup": {
        "ResourceGroupId": "rg-acfmzawhxxc****",
        "ResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      },
      "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
      "Tags": [
        {
          "Key": "usage1",
          "Value": "test1"
        }
      ],
      "CreateTime": "2021-12-07T08:06:44",
      "UpdateTime": "2021-12-07T08:06:44",
      "ResourceGroupId": "rg-acfm4nxcvht4pmi"
    }
  ]
}

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.