查询模板版本列表
功能介绍
根据用户请求条件从数据库筛选、查询启动模板的版本相关信息，支持按照image_id和flavor_id进行过滤。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/launch-template-versions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
查询返回的模板最大资源数。最多返回100个模板的信息。 |
|
marker |
否 |
String |
从marker指定的模板ID的下一条数据开始查询。 marker需要与limit配合使用。 |
|
launch_template_id |
否 |
String |
模板ID。 |
|
image_id |
否 |
String |
模板的镜像ID。 |
|
flavor_id |
否 |
String |
模板的规格ID。 |
|
version |
否 |
Array of Integers |
模板版本。 |
请求消息
无。
响应消息
响应参数如表3所示。
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_data |
Object |
创建云服务器的请求信息。详情请参见表5。 |
|
version_number |
Integer |
模板版本号。 |
|
version_id |
String |
模板版本ID。 |
|
version_description |
String |
模板版本描述。 |
|
created_at |
String |
模板版本创建时间。 |
|
launch_template_id |
String |
模板ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavor_id |
String |
依据模板创建云服务器的规格ID。 |
|
name |
String |
模板名称。 |
|
description |
String |
模板描述。 |
|
availability_zone_id |
String |
模板的可用区。 |
|
enterprise_project_id |
String |
模板企业项目ID |
|
auto_recovery |
Boolean |
开启自动恢复。 |
|
os_profile |
Object |
操作系统属性。详情请参见表6。 |
|
security_group_ids |
Array of strings |
安全组ID列表。全网卡生效。 |
|
network_interfaces |
Array of Objects |
网络接口。详情请参见表7。 |
|
block_device_mappings |
Array of Objects |
BDM挂载信息，以flavor限制为准。详情请参见表9。 |
|
market_options |
Object |
计费信息。详情请参见表11。 |
|
internet_access |
Object |
公网访问。详情请参见表13。 |
|
metadata |
Object |
用户自定义键值对。 |
|
tag_options |
Array of Objects |
创建虚拟机标签，目前仅支持给虚拟机打标签，后续会支持同时给相关资源如卷等打标签。详情请参见表16。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key_name |
String |
密钥名称。 |
|
user_data |
String |
创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。 |
|
iam_agency_name |
String |
委托名称。 |
|
enable_monitoring_service |
Boolean |
开启主机监控服务。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source_id |
String |
云服务器卷数据源类型。 |
|
source_type |
String |
卷设备源头类型。 |
|
encrypted |
Boolean |
是否加密。 |
|
cmk_id |
String |
密钥ID。 |
|
volume_type |
String |
卷类型。 |
|
volume_size |
Integer |
卷大小。 |
|
attachment |
Object |
磁盘接口。详情请参见表10。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
boot_index |
Integer |
加载顺序，0代表系统盘。 |
|
delete_on_termination |
Boolean |
磁盘是否随实例一同释放。
默认系统盘设置为true随实例释放，数据盘设置为false不随实例释放。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
market_type |
String |
计费类型。 |
|
spot_options |
Object |
spot实例相关参数。详情请参见表12。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
spot_price |
Float |
用户愿意为竞价实例每小时支付的最高价格。 |
|
block_duration_minutes |
Integer |
购买的竞价实例时长。 |
|
instance_interruption_behavior |
String |
竞价实例中断策略，当前支持immediate。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
publicip_type |
String |
弹性公网IP类型。 |
|
charging_mode |
String |
弹性公网IP计费类型。 |
|
bandwidth |
Object |
弹性公网IP带宽。详情请参见表15。 |
|
delete_on_termination |
Boolean |
弹性公网IP是否随实例一同释放。
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
share_type |
String |
带宽类型。 |
|
size |
Integer |
带宽大小。 |
|
charge_mode |
String |
计费类型。 |
|
id |
String |
带宽ID，创建WHOLE类型带宽的弹性公网IP时可以指定之前的共享带宽创建。 |
请求示例
查询模板版本列表。
GET https://{endpoint}/v3/{project_id}/launch-template-versions
响应示例
{
"launch_template_versions": [
{
"template_data": {
"flavor_id": "c1.2xlarge.2",
"name": "new-server",
"description": "test server",
"availability_zone_id": "az1.dc1",
"enterprise_project_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"auto_recovery": false,
"os_profile": {
"key_name": "new-key",
"user_data": "XXXXXXXXXXXXXXXX",
"iam_agency_name": "new-agency",
"enable_monitoring_service": false
},
"security_group_ids": [
"e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67"
],
"network_interfaces": [
{
"virsubnet_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"attachment": {
"device_index": 0
}
}
],
"block_device_mappings": [
{
"source_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"source_type": "image",
"encrypted": false,
"cmk_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"volume_type": "SATA",
"volume_size": 40,
"attachment": {
"boot_index": 0
}
}
],
"market_options": {
"market_type": "postpaid",
"spot_options": {
"spot_price": 3.5,
"block_duration_minutes": 60,
"instance_interruption_behavior": "immediate"
}
},
"internet_access": {
"publicip": {
"publicip_type": "5_bgp",
"charging_mode": "postPaid",
"bandwidth": {
"share_type": "PER",
"size": 2,
"charge_mode": "traffic",
"id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67"
}
}
},
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"tag_options": [
{
"tags": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
]
},
"version_number": 2,
"version_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"version_description": "this template version is used for XXXXXX",
"created_at": "XXXXX-XX-XX",
"launch_template_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67"
}
],
"page_info": {
"next_marker": "string"
}
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。
