列举模板
功能介绍
列举模板（ListTemplates）
此API用于列举当前局点下用户所有的模板
-
默认按照生成时间降序排序，最新生成的模板排列在最前面
-
注意：目前返回全量模板信息，即不支持分页
-
如果没有任何模板，则返回空list
-
如果用户需要详细的模板版本信息，请调用ListTemplateVersions
ListTemplates返回的信息只包含模板摘要信息（具体摘要信息见ListTemplatesResponseBody），如果用户需要详细的某个模板信息，请调用ShowTemplateMetadata
URI
GET /v1/{project_id}/templates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从调用API处获取，也可以从控制台获取。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Client-Request-Id |
是 |
String |
用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
templates |
Array of Template objects |
模板列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_id |
String |
模板的唯一ID，由模板服务随机生成 |
|
template_name |
String |
用户希望创建的模板名称 |
|
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 |
模板中最新模板版本的版本描述 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
请求示例
列举当前局点下用户所有的模板
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 |
服务器内部错误 |
