GenerateTemplateByScratch - Resource Orchestration Service

Generates a template for a resource scenario.

Operation description

In this example, a template is generated for a resource management scenario that resides in the China (Hangzhou) region. The ID of the resource scenario is ts-aa9c62feab844a6b****.

Note You cannot generate a template for a resource detection scenario.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:GenerateTemplateByScratch	list	TemplateScratch acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource scenario. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
TemplateScratchId	string	Yes	The ID of the resource scenario. For more information about how to query the IDs of resource scenarios, see ListTemplateScratches .	ts-aa9c62feab844a6b****
ProvisionRegionId	string	No	The region ID of the new node.	cn-hangzhou
TemplateType	string	No	The type of the template that Resource Orchestration Service (ROS) generates. ROS can generate templates of the ROS and Terraform types. Default value: ROS.	ROS

For more information about common request parameters, see API Reference.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
TemplateBody	string	The template content of the resource scenario.	{\"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>	The resources that you want to import into a stack in the resource management scenario. Note This parameter is returned only for a resource management scenario.
	object
ResourceType	string	The type of the resource.	ALIYUN::ECS::VPC
LogicalResourceId	string	The logical ID of the resource.	ECSVPC_001
ResourceIdentifier	object	The key-value mapping between strings. The value is a JSON string that identifies the resource that you want to import into a stack. A key is an identifier for a resource, and a value is an assignment of data to the key. For example, VpcId is a key that indicates the ID of a virtual private cloud (VPC), and `vpc-bp1m6fww66xbntjyc****"` is a value that is assigned to VpcId.	{"VpcId": "vpc-bp1m6fww66xbntjyc****" }

Examples

Sample success responses

JSONformat

{
  "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****"
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-25	The request parameters of the API has changed	View Change Details