查询模板列表 - ListTemplates
功能介绍
根据用户请求条件从数据库筛选、查询启动模板相关信息。
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| ecs:launchTemplates:list | list | - | - | - | - |
URI
GET /v3/{project_id}/launch-templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 查询返回的模板最大资源数。 约束限制: 最多返回100个模板的信息。 取值范围: 不涉及 默认取值: 不涉及 |
| marker | 否 | String | 参数解释: 从marker指定的模板ID的下一条数据开始查询。 约束限制: marker需要与limit配合使用。 取值范围: 不涉及 默认取值: 不涉及 |
| launch_template_id | 否 | Array of strings | 参数解释: 模板ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| name | 否 | Array of strings | 参数解释: 模板名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求消息
无。
响应消息
响应参数如表3所示。
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 模板id。 取值范围: 不涉及 |
| name | String | 参数解释: 模板名称。 取值范围: 不涉及 |
| description | String | 参数解释: 模板描述 取值范围: 不涉及 |
| created_at | String | 参数解释: 模板创建时间。 取值范围: 不涉及 |
| updated_at | String | 参数解释: 模板更新时间。 取值范围: 不涉及 |
| default_version | Integer | 参数解释: 模板默认版本号。 取值范围: 不涉及 |
| latest_version | Integer | 参数解释: 模板最新版本号。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 参数解释: 下一页的开始索引ID。 取值范围: 不涉及 |
| previous_marker | String | 参数解释: 上一页的开始索引ID。 取值范围: 不涉及 |
请求示例
查询模板列表。
GET https://{endpoint}/v3/{projectId}/launch-templates 响应示例
{
"launch_templates": [
{
"id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"name": "my-template",
"description": "this template is used for XXXXXX",
"created_at": "XXXXX-XX-XX",
"updated_at": "XXXXX-XX-XX",
"default_version": 2,
"latest_version": 3
}
],
"page_info": {
"next_marker": "string"
}
} 返回值
请参考通用请求返回值。
错误码
请参考错误码。