调用UpdateTemplate更新模板_资源编排(ROS)-阿里云帮助中心

通过指定模板地址或模板详情更新模板。

接口说明

更新模板时，请注意：

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ros:UpdateTemplate	update	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
TemplateURL	string	否	包含模板主体的文件的位置。URL 必须指向位于 Web 服务器（HTTP 或 HTTPS）或阿里云 OSS 存储桶（例如：oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou）中的模板，模板最大为 524,288 个字节。说明如果 OSS 地域未指定，默认与接口参数 RegionId 相同。您仅能指定 TemplateBody、TemplateURL 其中一个参数。 URL 的最大长度为：1024 个字节。	oss://ros/template/demo
TemplateName	string	否	模板的名称。长度不超过 255 个字符（utf-8 编码），必须以数字、英文字母或中文开头，可包含数字、英文字母、中文、短划线（-）和下划线（_）。	MyTemplate
Description	string	否	模板的描述。最大长度为 256 个字符。	It is a demo.
TemplateBody	string	否	模板主体的结构。长度为 1~524,288 个字节。如果长度较长，则建议通过 HTTP POST+Body Param 的方式，将参数放在请求体中进行传递，避免因 URL 过长而导致请求失败。说明您必须且仅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一个参数。	{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateId	string	是	模板 ID。支持共享模板和私有模板。	5ecd1e10-b0e9-4389-a565-e4c15efc****
ValidationOptions	array	否	校验选项。默认不启用任何选项，进行严格校验。
	string	否	校验选项。取值： BasicValidation：只对模板内容进行基本的结构校验。	BasicValidation
RotateStrategy	string	否	模板版本轮转策略。取值： None（默认值）：不轮转。模板版本数量达到上限时报错。 DeleteOldestNonSharedVersionWhenLimitExceeded：转轮删除未共享的模板版本。说明如果模板共享了所有版本，则无法轮转删除。当前的最新版本不会被转轮删除。无论是否使用了轮转删除，模板版本号无法超过 v65000。	None
IsDraft	boolean	否	是否更新 Draft（草稿）版本。取值： false（默认值）：如果传递了模板内容，则会创建一个新版本，并清除 Draft 版本。否则修改当前最新版本。 true：修改更新 Draft 版本。Draft 版本只能通过 GetTemplate 接口获取。ListTemplateVersions 接口不会返回。其他接口的 TemplateVersion 参数也不能指定 Draft。	false

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	8C5D90E1-66B6-496C-9371-3807F8DA80A8
TemplateId	string	模板 ID。	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	本次操作所作用的模板版本。	v2

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-08	OpenAPI 返回结构发生变更	查看变更详情
2024-08-01	OpenAPI 入参发生变更	查看变更详情
2024-01-12	API 内部配置变更，不影响调用	查看变更详情

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。