All Products
Search
Document Center

Resource Orchestration Service:GenerateTemplateByScratch

Last Updated:Apr 10, 2024

Creates a template for a scenario.

Operation description

In this example, a template is created for the scenario whose ID is ts-aa9c62feab844a6b****. The scenario is of the Resource Management type and resides in the China (Hangzhou) region.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ros:GenerateTemplateByScratchWrite
  • TemplateScratch
    acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the scenario.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
TemplateScratchIdstringYes

The ID of the scenario.

For more information about how to query the IDs of scenarios, see ListTemplateScratches .

ts-aa9c62feab844a6b****
ProvisionRegionIdstringNo

The region ID of the new node.

cn-hangzhou
TemplateTypestringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
TemplateBodystring

The template content of the 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}}}}
ResourcesToImportobject []

The resources that you want to import into a stack in the scenario.

Note This parameter is returned only if the scenario is of the Resource Management type.
ResourceTypestring

The type of the resource.

ALIYUN::ECS::VPC
LogicalResourceIdstring

The logical ID of the resource.

ECSVPC_001
ResourceIdentifierobject

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 timeSummary of changesOperation
2023-06-25The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: TemplateType