文档首页/ 资源编排服务 RFS/ API参考（吉隆坡区域）/ API/ 模板管理/ 删除模板
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

删除模板

功能介绍

删除模板（DeleteTemplate）

此API用于删除某个模板以及模板下的全部模板版本 请谨慎操作，删除模板将会删除模板下的所有模板版本。

  • template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成，为UUID。由于模板名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的模板，删除，再重新创建一个同名模板。对于团队并行开发，用户可能希望确保，当前我操作的模板就是我认为的那个，而不是其他队友删除后创建的同名模板。因此，使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同，更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致，则返回400

URI

DELETE /v1/{project_id}/templates/{template_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从调用API处获取，也可以从控制台获取。

项目ID获取方式

最小长度：3

最大长度：64

template_name

是

String

用户希望创建的模板名称

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

template_id

否

String

模板的ID。当template_id存在时，模板服务会检查template_id是否和template_name匹配，不匹配会返回400

最小长度：36

最大长度：36

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID

最小长度：36

最大长度：128

响应参数

状态码： 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

错误描述

请求示例

  • 删除模板 
    DELETE https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template
  • 删除模板，并提供模板id以校验是否与当前模板匹配 
    DELETE https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3

响应示例

无

状态码

状态码

描述

204

删除成功，无数据返回

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

模板不存在

429

请求数量过多

500

服务器内部错误
父主题： 模板管理