CreateTemplate - Resource Orchestration Service - Alibaba Cloud Documentation Center

Creates a custom template.

Operation description

This topic provides an example of how to create a template named MyTemplate in the China (Hangzhou) region (cn-hangzhou). The TemplateBody parameter is set to {"ROSTemplateFormatVersion": "2015-09-01"}.

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

create

*Template

acs:ros:{#regionId}:{#accountId}:template/*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateURL	string	No	The URL of the file that contains the template body. The URL must point to a template that is located on a web server (HTTP or HTTPS) or in an Alibaba Cloud Object Storage Service (OSS) bucket, such as oss://ros/stack-policy/demo or oss://ros/stack-policy/demo?RegionId=cn-hangzhou. The template body must be 1 to 1,024 bytes in length. If you do not specify the region of the OSS bucket, the value of the RegionId parameter is used. Note You must specify only one of the `TemplateBody` and `TemplateURL` parameters.	oss://ros/template/demo
Description	string	No	The description of the template. The description can be up to 256 characters in length.	It is a demo.
TemplateBody	string	No	The structure of the template body. The template body must be 1 to 524,288 bytes in length. If the template body is large, specify the parameter in the request body to prevent request failures caused by an excessively long URL. Note You can specify only one of the `TemplateBody`, `TemplateURL`, and `TemplateId` parameters.	{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateName	string	Yes	The name of the template. The name can be up to 255 characters in length. It must start with a digit, letter, or Chinese character. It can contain digits, letters, Chinese characters, hyphens (-), and underscores (_).	MyTemplate
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	The tags of the template.
	object	No	The tags of the template.
Key	string	Yes	The tag key of the template. Note Tags is an optional parameter. If you specify Tags, you must specify `Tags.N.Key`.	usage
Value	string	No	The tag value of the template.	test
ValidationOptions	array	No	The validation options. By default, no options are enabled and strict validation is performed.
	string	No	The validation option. Valid value: BasicValidation: performs only basic validation on the structure of the template.	BasicValidation

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8C5D90E1-66B6-496C-9371-3807F8DA80A8
TemplateId	string	The template ID.	5ecd1e10-b0e9-4389-a565-e4c15efc****

Examples

Success response

JSON format

{
  "RequestId": "8C5D90E1-66B6-496C-9371-3807F8DA80A8",
  "TemplateId": "5ecd1e10-b0e9-4389-a565-e4c15efc****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.