GetTemplateScratch - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

Obtiene los detalles de un escenario de recursos.

Descripción de la operación

Este tema proporciona un ejemplo de cómo consultar los detalles del escenario de recursos ts-7f7a704cf71c49a6**** en la región China (Hangzhou) y mostrar los datos de los nodos de origen.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ros:GetTemplateScratch

get

*TemplateScratch

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región del escenario de recursos. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
TemplateScratchId	string	No	El ID del escenario de recursos.	ts-7f7a704cf71c49a6****
ShowDataOption	string	No	La opción de visualización de datos. Valores válidos: Sources: muestra solo los datos de los nodos de origen. Este valor es aplicable cuando TemplateScratchType está establecido en ArchitectureDetection. Source: muestra solo los datos de los nodos de origen. Este valor es aplicable cuando TemplateScratchType no está establecido en ArchitectureDetection. Provisions: muestra solo los datos de los nuevos nodos. Este valor es aplicable cuando TemplateScratchType no está establecido en ArchitectureDetection. All: muestra todos los datos. Para obtener más información sobre los nodos de origen y los nuevos nodos, consulte Visión general. Nota Si no especifica este parámetro, los datos de los nodos no se muestran de forma predeterminada.	Source

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
TemplateScratch	object	El escenario de recursos.
TemplateScratchId	string	El ID del escenario de recursos.	ts-7f7a704cf71c49a6****
TemplateScratchType	string	El tipo del escenario de recursos. Valores válidos: ResourceImport: gestión de recursos. ArchitectureReplication: replicación de recursos.	ArchitectureReplication
Status	string	El estado del escenario de recursos. Valores válidos: GENERATE_IN_PROGRESS: en proceso de generación. GENERATE_COMPLETE: generado. GENERATE_FAILED: error en la generación.	GENERATE_COMPLETE
StatusReason	string	El motivo por el que falló la generación del escenario de recursos. Nota Este parámetro se devuelve solo cuando Status está establecido en GENERATE_FAILED.	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch
FailedCode	string	El código de estado que indica el motivo por el que falló la generación del escenario de recursos. Nota Este parámetro se devuelve solo cuando Status está establecido en GENERATE_FAILED.	InvalidZoneId
TemplateScratchData	object	Los datos del escenario de recursos.	Consulte el ejemplo de respuesta
PreferenceParameters	array<object>	Los parámetros de configuración del escenario de recursos.
	object
ParameterKey	string	El nombre del parámetro.	DeletionPolicy
ParameterValue	string	El valor del parámetro.	Retain
Description	string	La descripción del escenario de recursos.	复制VPC资源
SourceResources	array<object>	Los recursos de origen.
	object	Los recursos de origen.
ResourceId	string	El ID del recurso.	vpc-m5e7cv7e9mz69sszb****
ResourceType	string	El tipo de recurso.	ALIYUN::ECS::VPC
RelatedResourceTypeFilter	array	El filtro para tipos de recursos relacionados.
	string	El filtro para tipos de recursos relacionados.	ALIYUN::ECS::VPC
SourceTag	object	La etiqueta de origen.
ResourceTags	object	La etiqueta de origen.	{"a": "b"}
ResourceTypeFilter	array	El filtro de tipo de recurso.
	string	El filtro de tipo de recurso.	ALIYUN::ECS::VPC
SourceResourceGroup	object	El grupo de recursos de origen.
ResourceGroupId	string	El ID del grupo de recursos de origen.	rg-acfmzawhxxc****
ResourceTypeFilter	array	El filtro de tipo de recurso.
	string	El filtro de tipo de recurso.	ALIYUN::ECS::VPC
LogicalIdStrategy	string	La estrategia de generación de ID lógico. Valores válidos: LongTypePrefixAndIndexSuffix (predeterminado): prefijo de tipo largo con sufijo de índice. LongTypePrefixAndHashSuffix: prefijo de tipo largo con sufijo hash. ShortTypePrefixAndHashSuffix: prefijo de tipo corto con sufijo hash.	LongTypePrefixAndIndexSuffix
CreateTime	string	La hora en que se creó el escenario de recursos. La hora se muestra en UTC+0 y sigue el estándar ISO 8601 sin la Z final. Formato: AAAA-MM-DDThh:mm:ss.	2021-12-22T01:49:22
UpdateTime	string	La hora de la última actualización del escenario de recursos. La hora se muestra en UTC+0 y sigue el estándar ISO 8601 sin la Z final. Formato: AAAA-MM-DDThh:mm:ss.	2021-12-22T01:49:23
Stacks	array<object>	La lista de stacks asociados al escenario de recursos.
	object
StackId	string	El ID del stack.	3708bf6a-3a67-44d4-9eb1-c56704b9****
RegionId	string	El ID de la región del stack.	cn-hangzhou
UsageType	string	El propósito del stack. Valores válidos: ResourceImport: gestión de recursos. ArchitectureReplication: replicación de recursos.	ArchitectureReplication
StackProvision	object	La información de aprovisionamiento del stack.
Creatable	boolean	Indica si puede llamar a CreateStack para crear un stack para la replicación de recursos. Valores válidos: true: compatible. false: no compatible.	true
Importable	boolean	Indica si puede llamar a CreateChangeSet para crear un conjunto de cambios para la gestión de recursos. Valores válidos: true: compatible. false: no compatible.	false
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmzmhzoaad5oq

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.