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

Consulta a lista de cenários.

Este tópico apresenta um exemplo de como consultar a lista de cenários. Neste exemplo, são consultados os cenários criados na região China (Hangzhou). Os seguintes cenários são retornados: gerenciamento de recursos e replicação de recursos.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListTemplateScratches	A operação que você deseja executar. Defina o valor como ListTemplateScratches.
RegionId	String	Sim	cn-hangzhou	O ID da região onde o cenário foi criado. Chame a operação DescribeRegions para obter a lista de regiões mais recente.
TemplateScratchId	String	Não	ts-7f7a704cf71c49a6****	O ID do cenário.
TemplateScratchType	String	Não	ArchitectureReplication	O tipo do cenário. Valores válidos: ResourceImport: gerenciamento de recursos ArchitectureReplication: replicação de recursos
Status	String	Não	["GENERATE_COMPLETE"]	O estado do cenário. Valores válidos: GENERATE_IN_PROGRESS: o cenário está sendo criado. GENERATE_COMPLETE: o cenário foi criado com sucesso. GENERATE_FAILED: falha na criação do cenário.
Tags.N.Key	String	Sim	usage	A chave da tag N adicionada ao cenário. Nota O parâmetro Tags é opcional. Caso especifique o parâmetro Tags, você deve especificar também o parâmetro Tags.N.Key.
Tags.N.Value	String	Não	test	O valor da tag N adicionada ao cenário.
PageSize	Integer	Não	10	Número de entradas a serem retornadas em cada página. Valor máximo: 50. Valor padrão: 10.
PageNumber	Integer	Não	1	Número da página a ser retornada. A numeração das páginas começa em 1. Valor padrão: 1.

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

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	D1C09606-C58B-558F-9B4E-5BF263D17D09	O ID da solicitação.
TotalCount	Integer	2	O número total de cenários.
PageNumber	Integer	1	O número da página retornada.
PageSize	Integer	10	Quantidade de entradas retornadas por página.
TemplateScratches	Array of TemplateScratch		A lista de cenários.
TemplateScratchId	String	ts-48ad85d66cca4620****	O ID do cenário.
TemplateScratchType	String	ResourceImport	Tipo do cenário. Valores válidos: ResourceImport: gerenciamento de recursos ArchitectureReplication: replicação de recursos
Status	String	GENERATE_COMPLETE	Estado atual do cenário.
StatusReason	String	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.	Motivo da falha na criação do cenário. Nota Este parâmetro é retornado apenas quando o parâmetro Status está definido como GENERATE_FAILED.
FailedCode	String	InvalidZoneId	Código de status do cenário cuja criação falhou. Nota Este parâmetro é retornado apenas quando o parâmetro Status está definido como GENERATE_FAILED.
PreferenceParameters	Array of PreferenceParameter		Parâmetros configurados para o cenário.
ParameterKey	String	DeletionPolicy	Nome do parâmetro.
ParameterValue	String	Retain	Valor do parâmetro.
Description	String	Manages the virtual private cloud (VPC) resource.	Descrição do cenário.
SourceResources	Array of SourceResource		Recursos de source.
ResourceId	String	vpc-m5eauuq80anx59v28****	ID do recurso.
ResourceType	String	ALIYUN::ECS::VPC	Tipo do recurso.
SourceTag	Object		Tag de source.
ResourceTags	Map		Tags de source.
ResourceTypeFilter	Array of String	ALIYUN::ECS::VPC	Filtro para tipos de recursos.
SourceResourceGroup	Object		Grupo de recursos de source.
ResourceGroupId	String	rg-acfmzawhxxc****	ID do grupo de recursos de source.
ResourceTypeFilter	Array of String	ALIYUN::ECS::VPC	Filtro para tipos de recursos.
LogicalIdStrategy	String	LongTypePrefixAndIndexSuffix	Política usada para gerar o ID lógico. Valor padrão: LongTypePrefixAndIndexSuffix. Valores válidos: LongTypePrefixAndIndexSuffix: prefixo longo + sufixo de índice LongTypePrefixAndHashSuffix: prefixo longo + sufixo de hash ShortTypePrefixAndHashSuffix: prefixo curto + sufixo de hash
Tags	Array of Tags		Tags associadas ao cenário.
Key	String	usage1	Chave da tag do cenário.
Value	String	test1	Valor da tag do cenário.
CreateTime	String	2021-12-07T08:06:44	Horário de criação do cenário. O horário segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ss e é exibido em UTC.
UpdateTime	String	2021-12-07T08:06:44	Horário da última atualização do cenário. O horário segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ss e é exibido em UTC.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListTemplateScratches
&RegionId=cn-hangzhou
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTemplateScratchesResponse>
    <RequestId>D1C09606-C58B-558F-9B4E-5BF263D17D09</RequestId>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TemplateScratches>
        <TemplateScratchId>ts-48ad85d66cca4620****</TemplateScratchId>
        <TemplateScratchType>ResourceImport</TemplateScratchType>
        <Status>GENERATE_COMPLETE</Status>
        <StatusReason>Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.</StatusReason>
        <FailedCode>InvalidZoneId</FailedCode>
        <PreferenceParameters>
            <ParameterKey>DeletionPolicy</ParameterKey>
            <ParameterValue>Retain</ParameterValue>
        </PreferenceParameters>
        <Description> Manages the VPC resource. </Description>
        <SourceResources>
            <ResourceId>vpc-m5eauuq80anx59v28****</ResourceId>
            <ResourceType>ALIYUN::ECS::VPC</ResourceType>
        </SourceResources>
        <SourceTag>
            <ResourceTypeFilter>ALIYUN::ECS::VPC</ResourceTypeFilter>
        </SourceTag>
        <SourceResourceGroup>
            <ResourceGroupId>rg-acfmzawhxxc****</ResourceGroupId>
            <ResourceTypeFilter>ALIYUN::ECS::VPC</ResourceTypeFilter>
        </SourceResourceGroup>
        <LogicalIdStrategy>LongTypePrefixAndIndexSuffix</LogicalIdStrategy>
        <Tags>
            <Key>usage1</Key>
            <Value>test1</Value>
        </Tags>
        <CreateTime>2021-12-07T08:06:44</CreateTime>
        <UpdateTime>2021-12-07T08:06:44</UpdateTime>
    </TemplateScratches>
</ListTemplateScratchesResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : "Manages the VPC resource",
    "SourceResources" : {
      "ResourceId" : "vpc-m5eauuq80anx59v28****",
      "ResourceType" : "ALIYUN::ECS::VPC"
    },
    "SourceTag" : {
      "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"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.