调用CreateTemplate接口创建自定义模板。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTemplate

要执行的操作,取值:CreateTemplate。

TemplateURL String oss://ros/template/demo

包含模板主体的文件的位置。URL必须指向位于Web服务器(HTTP或HTTPS)或阿里云OSS存储空间(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的模板。

模板长度范围为1~1024字节。

如未指定OSS地域,默认与接口参数RegionId相同。

说明 您必须且仅能指定TemplateBody和TemplateURL其中一个参数。
Description String It is a demo.

模板的描述。最大长度为256个字符。

TemplateBody String {"ROSTemplateFormatVersion":"2015-09-01"}

模板主体的结构。长度为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类型模板结构

TemplateName String MyTemplate

模板的名称。

长度不超过255个字符,必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。

ResourceGroupId String rg-acfmxazb4ph6aiy****

资源组ID。

关于资源组的更多信息,请参见什么是资源组

Tags.N.Key String usage

模板的标签键。

说明 Tags为可选参数。如果需要指定Tags,则Tags.N.Key必须指定。
Tags.N.Value String test

模板的标签值。

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

返回数据

名称 类型 示例值 描述
RequestId String 8C5D90E1-66B6-496C-9371-3807F8DA80A8

请求ID。

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

模板ID。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=CreateTemplate
&TemplateName=MyTemplate
&TemplateBody={"ROSTemplateFormatVersion":"2015-09-01"}
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTemplateResponse>
        <RequestId>8C5D90E1-66B6-496C-9371-3807F8DA80A8</RequestId>
        <TemplateId>5ecd1e10-b0e9-4389-a565-e4c15efc****</TemplateId>
</CreateTemplateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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为具体原因。