DescribeLaunchTemplateVersions - 查询实例启动模板版本--云服务器-火山引擎

文档中心

导航

DescribeLaunchTemplateVersions - 查询实例启动模板版本

最近更新时间：2024.11.29 16:34:02首次发布时间：2024.08.15 14:19:16

调用 DescribeLaunchTemplateVersions 接口，查询实例启动模板版本。

请求参数

名字	类型	是否必填	示例值	描述
Action	String	是	DescribeLaunchTemplateVersions	要执行的操作，取值：DescribeLaunchTemplateVersions。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
LaunchTemplateId	String	否	LaunchTemplateId=lt-3ti78x9h8t4bw****	实例启动模板的ID。您必须指定`LaunchTemplateId`或`LaunchTemplateName`以确定模板。
LaunchTemplateName	String	否	LaunchTemplateNames=test	实例启动模板的名称。您必须指定`LaunchTemplateId`或`LaunchTemplateName`以确定模板。
LaunchTemplateVersions.N	Integer	否	1	实例启动模板版本，最多支持30个。参数 - N：表示实例启动模板的序号。多个版本之间用&分隔。
DefaultVersion	Boolean	否	true	是否查询默认版本，取值： true（默认）：查询默认版本。 false：不查询默认版本。
NextToken	String	否	-	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	10	分页查询时设置的每页行数：最大值：100 默认值：10

返回数据

名称	类型	示例值	描述
NextToken	String	-	本次调用返回的查询凭证值，返回为空表示该页为末页。
LaunchTemplateVersions	Array of Struct	-	符合条件的实例启动模板信息，具体请参见下表“LaunchTemplateVersions 结构”。

LaunchTemplateVersions 结构

名称	类型	示例值	描述
LaunchTemplateId	String	lt-ysxc16auaugh9zfy****	实例启动模板ID。
VersionNumber	String	1	模板版本号。
VersionDescription	String	testVersionDescription	模板版本描述。
LaunchTemplateVersionData	Object	-	模板配置信息，具体请参见下表“LaunchTemplateVersionData 结构”。
CreatedAt	String	2022-06-09 10:38:20	实例启动模板的创建时间。
UpdatedAt	String	2022-06-09 10:38:20	实例启动模板的更新时间。

LaunchTemplateVersionData 结构

名称	类型	示例值	描述
ImageId	String	image-ybmhzqo8u4l8j1ii****	镜像ID。
SecurityEnhancementStrategy	String	Active	是否开启安全加固，取值： Active：开启安全加固，仅对公共镜像生效。 InActive：关闭安全加固，对所有镜像生效。
InstanceTypeId	String	ecs.g3i.large	实例的规格。
KeyPairName	String	kp-test-123	实例绑定的密钥对。
InstanceName	String	instance-1	实例名称。
Description	String	用于测试的云服务器实例	实例描述。
HostName	String	instance-host-name	实例主机名。
UserData	String	IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******	实例的自定义数据。
ZoneId	String	cn-beijing-a	实例所属可用区ID。
Volumes	Array of Struct	-	实例绑定云盘信息，具体请参见下表“ Volumes 结构”。
Eip	Struct	-	实例绑定的公网IP信息，具体请参见下表“ Eip 结构”。
VpcId	String	vpc-3thbinq64t4bwbha****	私有网络ID。
HpcClusterId	String	hpcCluster-l8u24ovdmoab6opf****	高性能计算集群ID。
InstanceChargeType	String	PostPaid	实例和云盘的计费类型。取值： PostPaid：按量付费。 PrePaid：包年包月。
UniqueSuffix	Boolean	false	是否开启有序后缀，取值： true：开启有序后缀。 false：关闭有序后缀。
SuffixIndex	Integer	0	有序后缀的起始序号。
ProjectName	Stirng	default	实例所属项目。
SpotStrategy	String	NoSpot	按量计费的抢占式策略。，取值： NoSpot：表示创建正常按量计费实例。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。 SpotWithPriceLimit：设置出价上限的抢占式实例。
SpotPriceLimit	Float32	0.78	抢占式实例的每小时最高价格。
NetworkInterfaces	Array of Struct	-	实例挂载的网卡信息。具体请参见下表“NetworkInterfaces 结构”。
ScheduledInstance	Struct		弹性预约单信息，具体请参见下表“ ScheduledInstance 结构”
Tags	Array of Struct	-	实例的标签信息，具体请参见下表“ Tags 结构”。

Volume 结构

名称	类型	示例值	描述
VolumeType	String	ESSD_PL0	云盘的类型，取值： ESSD_PL0：极速型SSD PL0。 PTSSD：性能型SSD。
Size	Integer	100	云盘的容量，单位为GiB。
DeleteWithInstance	Boolean	true	云盘是否随实例释放，取值： true：云盘随实例释放。 false：云盘不随实例释放。

名称

类型

示例值

描述

VolumeType

String

ESSD_PL0

云盘的类型，取值：

ESSD_PL0：极速型SSD PL0。
PTSSD：性能型SSD。

Size

Integer

100

云盘的容量，单位为GiB。

DeleteWithInstance

Boolean

true

云盘是否随实例释放，取值：

true：云盘随实例释放。
false：云盘不随实例释放。

Eip 结构

名称	类型	示例值	描述
BillingType	Integer	2	公网IP的计费方式，取值： 2：按量计费-按带宽上限计费。 3：按量计费-按实际流量计费。
Bandwidth	Integer	1	公网IP的带宽上限，单位：Mbps。取值范围：1～200。默认值：1。
ISP	String	BGP	公网IP的线路类型，取值： BGP：BGP（多线）。 ChinaMobile：中国移动静态单线。 ChinaTelecom：中国电信静态单线。 ChinaUnicom：中国联通静态单线。
BandwidthPackageId	String	bwp-2zeo05qre24nhrqpy****	共享带宽包的ID。
SecurityProtectionTypes	List	[AntiDDoS_Enhanced]	公网IP的安全防护类型。取值： AntiDDoS_Enhanced：申请增强防护类型的公网IP，可加入到DDoS原生防护（企业版）实例。
SecurityProtectionInstanceId	Integer	200	安全防护包ID。

NetworkInterfaces 结构

名称	类型	示例值	描述
SubnetId	String	subnet-3tisodmzai4e8i4q****	子网ID。
SecurityGroupIds	List	["sg-3ti78x9h8t4bwbhb**", "sg-mj8jry2d3vnk5smt1a2ae**"]	安全组ID。

ScheduledInstance 结构

名称	类型	示例值	描述
ScheduledInstanceName	String	ESI-Name	弹性预约单的名称。
ScheduledInstanceDescription	String	用于测试的弹性预约单	弹性预约单的描述。

Tags 结构

名称	类型	示例值	描述
Key	String	k1	实例的标签键。
Value	String	v1	实例的标签值。

请求示例

GET /?Action=DescribeLaunchTemplateVersions&Version=2020-04-01&LaunchTemplateId=lt-ysxc16auaugh9zfy**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419160338010225133143077B****",
        "Action": "DescribeLaunchTemplateVersions",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "LaunchTemplateVersions": [
            {
                "LaunchTemplateId": "lt-ysxc16auaugh9zfy****",
                "VersionNumber": 1,
                "VersionDescription": "testVersionDescription",
                "LaunchTemplateVersionData": {
                    "ZoneId": "cn-beijing-a",
                    "InstanceTypeId": "ecs.g3i.large",
                    "ImageId": "image-ybmhzqo8u4l8j1ii****",
                    "InstanceChargeType": "PostPaid",
                    "InstanceName": "instance-1",
                    "Description": "用于测试的云服务器实例",
                    "HostName": "instance-host-name",
                    "UniqueSuffix": false,
                    "SuffixIndex": 0,
                    "KeyPairName": "kp-test-123",
                    "SecurityEnhancementStrategy": "Active",
                    "UserData": "IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******",
                    "HpcClusterId": "hpcCluster-l8u24ovdmoab6opf****",
                    "Volumes": [],
                    "NetworkInterfaces": [
                        {
                            "SubnetId": "subnet-3tisodmzai4e8i4q****",
                            "SecurityGroupIds": [
                                "sg-3ti78x9h8t4bwbhb****"
                            ],
                        },
                    ],
                    "Eip": {
                        "Bandwidth": 1,
                        "ISP": "BGP",
                        "BillingType": 2
                    },
                    "VpcId": "vpc-3thbinq64t4bwbha****"
                },
                "CreatedAt": "2022-06-09 10:38:20",
                "UpdatedAt": "2022-06-09 10:38:20"
            }
        ]
    }
}

错误码

HttpCode	错误码	错误信息	描述
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	账户ID不能为空。
400	QuotaExceeded.TemplateVersionQuota	You've reached the limit on the Quota.	该实例启动模板下版本数量超限额。
400	MissingParameter.LaunchTemplateNameAndLaunchTemplateId	The required parameter LaunchTemplateName and LaunchTemplateId is not supplied.	模版名称和模版ID不允许同时为空。
404	InvalidLaunchTemplate.NotFound	The specified LaunchTemplate does not exist.	指定的启动模板不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。