全部产品
Search
文档中心

资源编排:UpdateTemplate - 更新模板

更新时间:Mar 13, 2024

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

接口说明

更新模板时,请注意:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
TemplateURLstring

包含模板主体的文件的位置。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
TemplateNamestring

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

MyTemplate
Descriptionstring

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

It is a demo.
TemplateBodystring

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

说明 您必须且仅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一个参数。
{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateIdstring

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

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

8C5D90E1-66B6-496C-9371-3807F8DA80A8
TemplateIdstring

模板 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-12API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
HttpCode错误码错误信息描述
404TemplateNotFoundThe Tempalte ({ ID }) could not be found.模板不存在。
400InvalidSchema{reason}.模板格式不正确。reason 为具体原因。
400InvalidTemplateAttributeThe Referenced Attribute ({resource} {name}) is incorrect.模板包含不正确的资源属性(输出)引用。resource 为资源名,name 为属性名。
400InvalidTemplatePropertyTypeThe specified value type of ({resource} {section}) is incorrect.模板资源定义中的字段类型不正确。resource 为资源名,section 为字段名。
400InvalidTemplateReferenceThe specified reference "{name}" (in {referencer}) is incorrect.模板包含不正确的引用。name 为引用名,referencer 为引用者。
400InvalidTemplateSectionThe template section is invalid: {section}.模板包含无效的字段。section 为字段名。
400InvalidTemplateVersionThe template version is invalid: {reason}.模板版本不正确。reason 为具体原因。
400TemplateBeingProcessedTemplate { ID } is being processed, retry later.模板正在处理中,稍后再试。ID 为模板 ID。