调用CreateTemplate创建自定义模板_资源编排-阿里云帮助中心

创建自定义模板。

接口说明

本文将提供一个示例，在杭州地域cn-hangzhou创建一个名为MyTemplate的模板，并将模板的结构TemplateBody设置为{"ROSTemplateFormatVersion": "2015-09-01"}。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:CreateTemplate	Write	Template acs:ros:{#regionId}:{#accountId}:template/*	无	无

请求参数

名称	类型	必填	描述	示例值
TemplateURL	string	否	包含模板主体的文件的位置。URL必须指向位于Web服务器（HTTP或HTTPS）或阿里云OSS存储空间（例如：oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou）中的模板。模板长度范围为1~1024字节。如未指定OSS地域，默认与接口参数RegionId相同。说明您必须且仅能指定TemplateBody和TemplateURL其中一个参数。	oss://ros/template/demo
Description	string	否	模板的描述。最大长度为256个字符。	It is a demo.
TemplateBody	string	否	模板主体的结构。长度为1~524,288个字节。如果长度较长，则建议通过HTTP POST+Body Param的方式，将参数放在请求体中进行传递，避免因URL过长而导致请求失败。说明您必须且仅能指定TemplateBody和TemplateURL其中一个参数。您也可以根据需要，创建Terraform类型模板，示例如下： `{ "ROSTemplateFormatVersion": "2015-09-01", "Transform": "Aliyun::Terraform-v1.0", "Workspace": { "main.tf": "variable \"name\" { default = \"auto_provisioning_group\"}" }, "Outputs": {} }` 关于Terraform类型模板的更多信息，请参见Terraform类型模板结构。	{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateName	string	是	模板的名称。长度不超过255个字符，必须以数字或英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_）。	MyTemplate
ResourceGroupId	string	否	资源组ID。关于资源组的更多信息，请参见什么是资源组。	rg-acfmxazb4ph6aiy****
Tags	object []	否	模板的标签。
Key	string	是	模板的标签键。说明 Tags为可选参数。如果需要指定Tags，则Tags.N.Key必须指定。	usage
Value	string	否	模板的标签值。	test

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	8C5D90E1-66B6-496C-9371-3807F8DA80A8
TemplateId	string	模板ID。	5ecd1e10-b0e9-4389-a565-e4c15efc****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2022-10-27

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更
	新增入参：Tags

HttpCode	错误码	错误信息	描述
400	InvalidSchema	{reason}.	模板格式不正确。reason为具体原因。
400	InvalidTemplateAttribute	The Referenced Attribute ({resource} {name}) is incorrect.	模板包含不正确的资源属性（输出）引用。resource为资源名，name为属性名。
400	InvalidTemplatePropertyType	The specified value type of ({resource} {section}) is incorrect.	模板资源定义中的字段类型不正确。resource为资源名，section为字段名。
400	InvalidTemplateReference	The specified reference "{name}" (in {referencer}) is incorrect.	模板包含不正确的引用。name为引用名，referencer为引用者。
400	InvalidTemplateSection	The template section is invalid: {section}.	模板包含无效的字段。section为字段名。
400	InvalidTemplateVersion	The template version is invalid: {reason}.	模板版本不正确。reason为具体原因。