文档首页> 资源编排服务 RFS> API参考> 资源编排API> 模板管理> 列举模板
更新时间：2024-04-19 GMT+08:00
查看PDF
分享

列举模板

功能介绍

列举模板（ListTemplates）

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

  • 默认按照生成时间降序排序，最新生成的模板排列在最前面

  • 注意：目前返回全量模板信息，即不支持分页

  • 如果没有任何模板，则返回空list

  • 如果用户需要详细的模板版本信息，请调用ListTemplateVersions

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

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

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

    相关文档

    相关产品