本文导读

展开导读

文档首页/ 资源编排服务 RFS/ API参考（吉隆坡区域）/ API/ 模板管理/ 列举模板

列举模板

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

在线调试

CLI示例

查看PDF

功能介绍

列举模板（ListTemplates）

此API用于列举当前局点下用户所有的模板

默认按照生成时间降序排序，最新生成的模板排列在最前面
注意：目前返回全量模板信息，即不支持分页
如果没有任何模板，则返回空list
如果用户需要详细的模板版本信息，请调用ListTemplateVersions

ListTemplates返回的信息只包含模板摘要信息（具体摘要信息见ListTemplatesResponseBody），如果用户需要详细的某个模板信息，请调用ShowTemplateMetadata

URI

GET /v1/{project_id}/templates

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，可以从调用API处获取，也可以从控制台获取。项目ID获取方式最小长度：3 最大长度：64

请求参数

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

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
templates	Array of Template objects	模板列表数组长度：0 - 100

表4 Template
参数	参数类型	描述
template_id	String	模板的唯一ID，由模板服务随机生成最小长度：36 最大长度：36
template_name	String	用户希望创建的模板名称最小长度：1 最大长度：128
template_description	String	模板的描述。可用于客户识别自己的模板最小长度：0 最大长度：1024
create_time	String	模板的生成时间，格式遵循RFC3339，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z
update_time	String	模板的更新时间，格式遵循RFC3339，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z
latest_version_id	String	模板中最新的模板版本ID 最小长度：2 最大长度：11
latest_version_description	String	模板中最新模板版本的版本描述最小长度：0 最大长度：1024

状态码： 400

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

状态码： 401

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

状态码： 403

表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	错误描述

请求示例

列举当前局点下用户所有的模板

GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates

响应示例

状态码： 200

列举模板成功

{
  "templates" : [ {
    "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8",
    "template_name" : "my_first_template",
    "template_description" : "模板描述",
    "create_time" : "2023-05-09T08:00:00Z",
    "update_time" : "2023-05-09T09:00:00Z",
    "latest_version_description" : "最新版本描述",
    "latest_version_id" : "V10"
  }, {
    "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c9",
    "template_name" : "my_second_template",
    "template_description" : "模板描述",
    "create_time" : "2023-05-09T09:00:00Z",
    "update_time" : "2023-05-09T10:00:00Z",
    "latest_version_description" : "最新版本描述",
    "latest_version_id" : "V10"
  } ]
}

状态码

状态码	描述
200	列举模板成功
400	用户请求非法
401	用户身份认证失败
403	用户无权限调用此API
429	请求数量过多
500	服务器内部错误

父主题： 模板管理

上一篇：模板管理

下一篇：删除模板

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消