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

调试

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

请求参数

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

系统规定参数。取值:CreateTemplate

TemplateName String MyTemplate

模板的名称。模板名称可以包含数字、字母(大小写敏感)、连字符、下划线,必须以数字或字母开头,长度不超过255个字符。

TemplateURL String oss://ros/template/demo

模板文件的位置。模板文件最大为524288个字节。URL必须指向位于Web服务器(http、https)或阿里云OSS存储空间(例如oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou。OSS地域如未指定,默认与接口参数RegionId相同。)中的模板。您必须指定TemplateBodyTemplateURL参数,但不能同时指定。URL的最大长度为1024个字节。

Description String It is a demo.

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

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

模板主体的结构。长度为1~524,288个字节。如果长度较大,则建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免URL过长而导致请求失败。您必须指定参数TemplateBodyTemplateURL,但不能同时指定。

返回数据

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

请求ID。

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

模板ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTemplate
&TemplateName=MyTemplate
&<公共请求参数>

正常返回示例

XML 格式

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

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