调用UpdateTemplate接口更新模板。

更新模板时,请注意:

  • 如果指定了TemplateBody或TemplateURL,更新模板成功后,模板版本加1。例如:版本由v1变为v2。
  • 如果未指定TemplateBody和TemplateURL,模板版本不变。
  • 模板最多拥有100个版本。如果版本达到上限,模板将更新失败,您需要重新创建模板。

调试

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

请求参数

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

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

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

模板ID。支持共享模板和私有模板。

TemplateURL String oss://ros/template/demo

包含模板主体的文件的位置。URL必须指向位于Web服务器(HTTP或HTTPS)或阿里云OSS存储桶(例如:oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板最大为524,288个字节。

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

您仅能指定TemplateBody、TemplateURL其中一个参数。

URL的最大长度为:1024个字节。

TemplateName String MyTemplate

模板的名称。

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

Description String It is a demo.

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

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

模板的结构。长度为1~524,288个字节。

如果长度较大,建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免URL过长而导致请求失败。

您仅能指定TemplateBody、TemplateURL其中一个参数。

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

返回数据

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

请求ID。

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

模板ID。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=UpdateTemplate
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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

HttpCode

错误码

错误信息

描述

404

TemplateNotFound

The Tempalte ({ ID }) could not be found.

模板不存在。

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

400

TemplateBeingProcessed

Template { ID } is being processed, retry later.

模板正在处理中,稍后再试。ID为模板ID。