更新时间:2025-08-26 GMT+08:00
分享

列举模板

功能介绍

列举模板(ListTemplates)

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

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

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

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

  • 支持分页返回。如果响应中存在next_marker,则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中,在请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null

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

调试

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

URI

GET /v1/{project_id}/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

分页标记。当一页无法返回所有结果,上一次的请求将返回next_marker以指引还有更多页数,用户可以将next_marker中的值放到此处以查询下一页的信息。此marker只能用于与上一请求指定的相同参数的请求。不指定时默认从第一页开始查询。

limit

Integer

每页返回的最多结果数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

String

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

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

templates

Array of Template objects

模板列表

page_info

PageInfo object

分页信息

表5 Template

参数

参数类型

描述

template_id

String

模板的唯一ID,由模板服务随机生成

template_name

String

模板(Template)的名字。此名字在domain_id+region下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。

template_description

String

模板的描述。可用于客户识别自己的模板

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

latest_version_description

String

模板中最新模板版本的版本描述

表6 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。如果存在,则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中,在请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。

previous_marker

String

向前分页标识符。

current_count

Integer

本页显示的条目数量。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。

表8 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。

表10 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码:403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。

表12 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码:429

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。

表14 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码:500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。

表16 Detail

参数

参数类型

描述

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

服务器内部错误

相关文档