通过指定模板地址或模板详情更新模板。
接口说明
更新模板时,请注意:
- 如果指定了 TemplateBody 或 TemplateURL,更新模板成功后,模板版本加 1。例如:版本由 v1 变为 v2。
- 如果未指定 TemplateBody 和 TemplateURL,模板版本不变。
- 模板最多拥有 100 个版本。如果版本达到上限,模板将更新失败,您需要重新创建模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateURL | string | 否 | 包含模板主体的文件的位置。URL 必须指向位于 Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储桶(例如:oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou)中的模板,模板最大为 524,288 个字节。 说明
如果 OSS 地域未指定,默认与接口参数 RegionId 相同。
您仅能指定 TemplateBody、TemplateURL 其中一个参数。 | oss://ros/template/demo |
TemplateName | string | 否 | 模板的名称。 | 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**** |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "8C5D90E1-66B6-496C-9371-3807F8DA80A8",
"TemplateId": "5ecd1e10-b0e9-4389-a565-e4c15efc****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
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。 |