本文导读

展开导读

文档首页/ 资源编排服务 RFS/ API参考（吉隆坡区域）/ API/ 模板管理/ 更新模板元数据

更新模板元数据

更新时间：2024-12-12 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

更新模板元数据（UpdateTemplateMetadata）

此API用于更新模板元数据

此api只支持更新模板描述

URI

PATCH /v1/{project_id}/templates/{template_name}/metadata

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，可以从调用API处获取，也可以从控制台获取。项目ID获取方式最小长度：3 最大长度：64
template_name	是	String	用户希望创建的模板名称最小长度：1 最大长度：128

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Client-Request-Id	是	String	用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID 最小长度：36 最大长度：128

表3 请求Body参数
参数	是否必选	参数类型	描述
template_id	否	String	模板的唯一ID，由模板服务随机生成最小长度：36 最大长度：36
template_description	否	String	模板的描述。可用于客户识别自己的模板最小长度：0 最大长度：1024

响应参数

状态码： 400

表4 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 401

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 403

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 404

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 429

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 500

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

更新模板元数据

PATCH https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/metadata

{
  "template_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
  "template_description" : "my template description"
}

响应示例

无

状态码

状态码	描述
204	更新模板元数据成功，无数据返回
400	用户请求非法
401	用户身份认证失败
403	用户无权限调用此API
404	模板不存在
429	请求数量过多
500	服务器内部错误

父主题： 模板管理

上一篇：删除模板

下一篇：获取模板元数据

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

更新模板元数据

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

意见反馈

文档内容是否对您有帮助？

文档反馈