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

Descripción de la operación

En este ejemplo, se genera una plantilla para un escenario de gestión de recursos que reside en la región China (Hangzhou). El ID del escenario de recursos es ts-aa9c62feab844a6b****.

Nota

No puede generar una plantilla para un escenario de detección de recursos.

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

list

*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 la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
TemplateScratchId	string	Sí	El ID del escenario de recursos. Para obtener más información sobre cómo consultar los ID de los escenarios de recursos, consulte ListTemplateScratches.	ts-aa9c62feab844a6b****
ProvisionRegionId	string	No	El ID de la región del nuevo nodo.	cn-hangzhou
TemplateType	string	No	El tipo de plantilla que genera Resource Orchestration Service (ROS). ROS puede generar plantillas de los tipos ROS y Terraform. Valor predeterminado: ROS.	ROS

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
TemplateBody	string	El contenido de la plantilla del escenario de recursos.	{\"ROSTemplateFormatVersion\": \"2015-09-01\", \"Resources\": {\"ECSVPC_001\": {\"DeletionPolicy\": \"Retain\", \"Type\": \"ALIYUN::ECS::VPC\", \"Properties\": {\"CidrBlock\": \"172.16.0.0/12\", \"VpcName\": \"MyTestVpc\", \"EnableIpv6\": false}}}}
ResourcesToImport	array<object>	Los recursos que desea importar a una pila en el escenario de gestión de recursos. Nota Este parámetro se devuelve solo para un escenario de gestión de recursos.
	array<object>
ResourceType	string	El tipo del recurso.	ALIYUN::ECS::VPC
LogicalResourceId	string	El ID lógico del recurso.	ECSVPC_001
ResourceIdentifier	object	La asignación de pares clave-valor entre cadenas. El valor es una cadena JSON que identifica el recurso que desea importar a una pila. Una clave es un identificador de un recurso y un valor es una asignación de datos a la clave. Por ejemplo, VpcId es una clave que indica el ID de una nube privada virtual (VPC), y `vpc-bp1m6fww66xbntjyc****"` es un valor asignado a VpcId.	{"VpcId": "vpc-bp1m6fww66xbntjyc****" }

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D22C1D13-D74E-558C-AF68-1B4C05FA6F1A",
  "TemplateBody": "{\\\"ROSTemplateFormatVersion\\\": \\\"2015-09-01\\\", \\\"Resources\\\": {\\\"ECSVPC_001\\\": {\\\"DeletionPolicy\\\": \\\"Retain\\\", \\\"Type\\\": \\\"ALIYUN::ECS::VPC\\\", \\\"Properties\\\": {\\\"CidrBlock\\\": \\\"172.16.0.0/12\\\", \\\"VpcName\\\": \\\"MyTestVpc\\\", \\\"EnableIpv6\\\": false}}}}",
  "ResourcesToImport": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceId": "ECSVPC_001",
      "ResourceIdentifier": {
        "VpcId": "vpc-bp1m6fww66xbntjyc****"
      }
    }
  ]
}

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.