All Products
Search
Document Center

Resource Orchestration Service:CreateTemplate

Last Updated:Jul 17, 2024

Creates a custom template.

Operation description

In this topic, a custom template named MyTemplate is created in the cn-hangzhou region. The TemplateBody parameter of the template is set to {"ROSTemplateFormatVersion": "2015-09-01"}.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateURLstringNo

The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server 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 RegionId is used.

Note You must specify TemplateBody or TemplateURL.
oss://ros/template/demo
DescriptionstringNo

The description of the template. The description can be up to 256 characters in length.

It is a demo.
TemplateBodystringNo

The structure of the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body exceeds the upper limit, we recommend that you add parameters to the HTTP POST request body to prevent request failures caused by excessively long URLs.

Note You must specify TemplateBody or TemplateURL.

You can create a Terraform template based on your business requirements. The following sample code provides an example on how to create a Terraform template:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Transform": "Aliyun::Terraform-v1.0",
  "Workspace": {
    "main.tf": "variable  \"name\" {  default = \"auto_provisioning_group\"}"
  },
  "Outputs": {}
}

For more information about Terraform templates, see Structure of Terraform templates.

{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateNamestringYes

The name of the template.
The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or a letter.

MyTemplate
ResourceGroupIdstringNo

The ID of the resource group.
For more information about resource groups, see Resource groups.

rg-acfmxazb4ph6aiy****
Tagsarray<object>No

The tags of the template.

objectNo

The tag of the template.

KeystringYes

The tag key of the template.

Note Tags is optional. If you need to specify Tags, you must also specify Key.
usage
ValuestringNo

The tag value of the template.

test

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

8C5D90E1-66B6-496C-9371-3807F8DA80A8
TemplateIdstring

The ID of the template.

5ecd1e10-b0e9-4389-a565-e4c15efc****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-12The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-10-27The request parameters of the API has changedView Change Details