列举模板版本
功能介绍
列举模板版本信息(ListTemplateVersions)
此API用于列举模板下所有的模板版本信息
- 默认按照生成时间降序排序,最新生成的模板排列在最前面
- 注意:目前返回全量模板版本信息,即不支持分页
- 如果没有任何模板版本,则返回空list
- template_id是模板的唯一Id。此Id由资源编排服务在生成模板的时候生成,为UUID。由于模板名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的模板,删除,再重新创建一个同名模板。对于团队并行开发,用户可能希望确保,当前我操作的模板就是我认为的那个,而不是其他队友删除后创建的同名模板。因此,使用ID就可以做到强匹配。资源编排服务保证每次创建的模板所对应的ID都不相同,更新不会影响ID。如果给予的template_id和当前模板管理的ID不一致,则返回400
- 如果模板不存在则返回404
ListTemplateVersions返回的信息只包含模板版本摘要信息(具体摘要信息见ListTemplateVersionsResponseBody),如果用户需要了解模板版本内容,请调用ShowTemplateVersionContent
URI
GET /v1/{project_id}/templates/{template_name}/versions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从调用API处获取,也可以从控制台获取。 最小长度:3 最大长度:64 |
template_name |
是 |
String |
用户希望创建的模板名称 最小长度:1 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
template_id |
否 |
String |
模板的ID。当template_id存在时,模板服务会检查template_id是否和template_name匹配,不匹配会返回400 最小长度:36 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Client-Request-Id |
是 |
String |
用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID 最小长度:36 最大长度:128 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
versions |
Array of TemplateVersion objects |
模板版本列表 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
template_id |
String |
模板的唯一ID,由模板服务随机生成 最小长度:36 最大长度:36 |
template_name |
String |
用户希望创建的模板名称 最小长度:1 最大长度:128 |
version_description |
String |
模板版本的描述。可用于客户识别自己的模板版本 最小长度:0 最大长度:1024 |
create_time |
String |
版本创建时间,格式遵循RFC3339,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z |
version_id |
String |
模板模板版本ID 最小长度:2 最大长度:11 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 429
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
- 列举当前模板的所有的模板版本信息
GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions
- 列举当前模板的所有的模板版本信息,并提供模板id以校验是否与当前模板匹配
GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3
响应示例
状态码: 200
列举模板版本成功
{ "versions" : [ { "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8", "template_name" : "my_first_template", "version_description" : "当前模板的第二个版本", "create_time" : "2023-05-09T08:01:24Z", "version_id" : "V2" }, { "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8", "template_name" : "my_first_template", "version_description" : "当前模板的第一个版本", "create_time" : "2023-05-09T08:01:23Z", "version_id" : "V1" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
列举模板版本成功 |
400 |
用户请求非法 |
401 |
用户身份认证失败 |
403 |
用户无权限调用此API |
404 |
模板不存在 |
429 |
请求数量过多 |
500 |
服务器内部错误 |