Automate ROS Template Creation from Resource Scenarios via API - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:GenerateTemplateByScratch

list

*TemplateScratch

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

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 elements

Element	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.
	array<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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.