ListTemplateScratches - - Centro de documentación de Alibaba Cloud

Consulta la lista de escenarios.

Este tema proporciona un ejemplo sobre cómo consultar la lista de escenarios. En este ejemplo, se consultan los escenarios creados en la región China (Hangzhou). A continuación se devuelven los siguientes escenarios: gestión de recursos y replicación de recursos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de muestra de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListTemplateScratches	La operación que desea realizar. Establezca el valor en ListTemplateScratches.
RegionId	String	Sí	cn-hangzhou	El ID de la región donde se creó el escenario. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
TemplateScratchId	String	No	ts-7f7a704cf71c49a6****	El ID del escenario.
TemplateScratchType	String	No	ArchitectureReplication	El tipo de escenario. Valores válidos: ResourceImport: gestión de recursos ArchitectureReplication: replicación de recursos
Status	String	No	["GENERATE_COMPLETE"]	El estado del escenario. Valores válidos: GENERATE_IN_PROGRESS: El escenario se está creando. GENERATE_COMPLETE: El escenario se ha creado. GENERATE_FAILED: Error al crear el escenario.
Tags.N.Key	String	Sí	usage	La clave de la etiqueta N agregada al escenario. Nota El parámetro Tags es opcional. Si especifica el parámetro Tags, debe especificar el parámetro Tags.N.Key.
Tags.N.Value	String	No	test	El valor de la etiqueta N agregada al escenario.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Valor máximo: 50. Valor predeterminado: 10.
PageNumber	Integer	No	1	El número de la página que se devolverá. Las páginas comienzan desde la página 1. Valor predeterminado: 1.

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	D1C09606-C58B-558F-9B4E-5BF263D17D09	El ID de la solicitud.
TotalCount	Integer	2	El número total de escenarios.
PageNumber	Integer	1	El número de la página devuelta.
PageSize	Integer	10	El número de entradas devueltas por página.
TemplateScratches	Array of TemplateScratch		La lista de escenarios.
TemplateScratchId	String	ts-48ad85d66cca4620****	El ID del escenario.
TemplateScratchType	String	ResourceImport	El tipo de escenario. Valores válidos: ResourceImport: gestión de recursos ArchitectureReplication: replicación de recursos
Status	String	GENERATE_COMPLETE	El estado del escenario.
StatusReason	String	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.	El motivo por el cual falló la creación del escenario. Nota Este parámetro se devuelve solo si el parámetro Status está establecido en GENERATE_FAILED.
FailedCode	String	InvalidZoneId	El código de estado del escenario cuya creación falló. Nota Este parámetro se devuelve solo si el parámetro Status está establecido en GENERATE_FAILED.
PreferenceParameters	Array of PreferenceParameter		Los parámetros configurados para el escenario.
ParameterKey	String	DeletionPolicy	El nombre del parámetro.
ParameterValue	String	Retain	El valor del parámetro.
Description	String	Manages the virtual private cloud (VPC) resource.	La descripción del escenario.
SourceResources	Array of SourceResource		Los recursos de origen.
ResourceId	String	vpc-m5eauuq80anx59v28****	El ID del recurso.
ResourceType	String	ALIYUN::ECS::VPC	El tipo de recurso.
SourceTag	Object		La etiqueta de origen.
ResourceTags	Map		Las etiquetas de origen.
ResourceTypeFilter	Array of String	ALIYUN::ECS::VPC	El filtro para tipos de recursos.
SourceResourceGroup	Object		El resource group de origen.
ResourceGroupId	String	rg-acfmzawhxxc****	El ID del resource group de origen.
ResourceTypeFilter	Array of String	ALIYUN::ECS::VPC	El filtro para tipos de recursos.
LogicalIdStrategy	String	LongTypePrefixAndIndexSuffix	La directiva según la cual se genera el ID lógico. Valor predeterminado: LongTypePrefixAndIndexSuffix. Valores válidos: LongTypePrefixAndIndexSuffix: prefijo de tipo largo + sufijo de tipo índice LongTypePrefixAndHashSuffix: prefijo de tipo largo + sufijo de tipo hash ShortTypePrefixAndHashSuffix: prefijo de tipo corto + sufijo de tipo hash
Tags	Array of Tags		Las etiquetas del escenario.
Key	String	usage1	La clave de la etiqueta del escenario.
Value	String	test1	El valor de la etiqueta del escenario.
CreateTime	String	2021-12-07T08:06:44	La hora en que se creó el escenario. La hora sigue el estándar ISO 8601 en formato AAAA-MM-DDThh:mm:ss. La hora se muestra en UTC.
UpdateTime	String	2021-12-07T08:06:44	La hora en que se actualizó el escenario. La hora sigue el estándar ISO 8601 en formato AAAA-MM-DDThh:mm:ss. La hora se muestra en UTC.

Ejemplos

Solicitudes de muestra

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

Respuestas exitosas de muestra

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 error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.