You need to enable JavaScript to run this app.
文档中心
云服务器

云服务器

复制全文
下载 pdf
启动模版
DescribeLaunchTemplateVersions - 查询实例启动模板版本
复制全文
下载 pdf
DescribeLaunchTemplateVersions - 查询实例启动模板版本
调用 DescribeLaunchTemplateVersions 接口,查询实例启动模板版本。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeLaunchTemplateVersions​
要执行的操作,取值:DescribeLaunchTemplateVersions。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
LaunchTemplateId string 可选 示例值:lt-ysxc16auaugh9zfy****​
实例启动模板的 ID。​
说明​
您必须指定LaunchTemplateId或LaunchTemplateName以确定模板。​
​
LaunchTemplateName string 可选 示例值:test​
实例启动模板的名称。​
说明​
您必须指定LaunchTemplateId或LaunchTemplateName以确定模板。​
​
DefaultVersion boolean 可选 示例值:true​
是否查询默认版本,取值:​
  • true(默认):查询默认版本。​
  • false:不查询默认版本。​
​
NextToken string 可选 示例值:--​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
MaxResults integer 可选 示例值:10​
分页查询时设置的每页行数:​
  • 最大值:100​
  • 默认值:10​
​
LaunchTemplateVersions.N integer[] 可选 示例值:1​
实例启动模板版本,最多支持30个。​
  • 参数 - N:表示实例启动模板的序号。​
  • 多个版本之间用&分隔。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
NextToken string 示例值:--​
本次调用返回的查询凭证值,返回为空表示该页为末页。​
​
LaunchTemplateVersions object[] 示例值:​
符合条件的实例启动模板信息。​
LaunchTemplateId string 示例值:lt-ysxc16auaugh9zfy****​
实例启动模板 ID。​
​
VersionDescription string 示例值:test​
模版版本描述。​
​
LaunchTemplateVersionData object 示例值:--​
模板配置信息。​
InstanceTypeId string 示例值:ecs.g1.large​
实例的规格。​
​
KeyPairName string 示例值:kp-test-123​
实例绑定的密钥对。​
​
UserData string 示例值:ZWNobyBoZWxsbyBlY3Mh​
实例的自定义数据。​
​
InstanceName string 示例值:instance-test​
实例名称。​
​
Description string 示例值:ECS​
实例描述。​
​
HostName string 示例值:instance-host-name​
实例主机名。​
​
ZoneId string 示例值:cn-beijing-a​
实例所属可用区ID。​
​
VpcId string 示例值:vpc-3thbinq64t4bwbha****​
私有网络ID。​
​
HpcClusterId string 示例值:hpcCluster-l8u24ovdmoab6opf****​
高性能计算集群ID。​
​
InstanceChargeType string 示例值:PostPaid​
实例和云盘的计费类型。取值:​
  • PostPaid:按量付费。​
  • PrePaid:包年包月。​
​
SuffixIndex integer 示例值:1​
有序后缀的起始序号。​
​
UniqueSuffix boolean 示例值:false​
是否开启有序后缀,取值:​
  • true:开启有序后缀。​
  • false:关闭有序后缀。​
​
ProjectName string 示例值:default​
实例所属项目。​
​
SpotStrategy string 示例值:NoSpot​
按量计费的抢占式策略。取值:​
  • NoSpot:表示创建正常按量计费实例。​
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。​
  • SpotWithPriceLimit:设置出价上限的抢占式实例。​
​
SpotPriceLimit float 示例值:0.78​
抢占式实例的每小时最高价格。​
​
ImageId string 示例值:image-ybmhzqo8u4l8j1ii****​
镜像ID。​
​
SecurityEnhancementStrategy string 示例值:Active​
是否开启安全加固,取值:​
  • Active:开启安全加固,仅对公共镜像生效。​
  • InActive:关闭安全加固,对所有镜像生效。​
​
Volumes object[]​
实例绑定的云盘信息。​
VolumeType string 示例值:ESSD_PL0​
云盘的类型,取值:​
  • ESSD_PL0:极速型SSD PL0。​
  • PTSSD:性能型SSD。​
​
Size integer 示例值:100​
云盘的容量,单位为GiB。​
​
DeleteWithInstance boolean 示例值:false​
云盘是否随实例释放,取值:​
  • true:云盘随实例释放。​
  • false:云盘不随实例释放。​
​
ExtraPerformanceTypeId string 示例值:Balance​
云盘额外性能的类型,仅ESSD FlexPL数据盘支持。关于额外性能的更多介绍,请参见云盘额外性能。取值:​
  • Balance:均衡型额外性能。​
  • IOPS:IOPS型额外性能。​
  • Throughput:吞吐量型额外性能。​
说明​
  • 参数 - N:表示云盘的序号,取值范围:1~16。N = 1表示系统盘,故N传入1时,该参数将被忽略。N ≥ 2表示数据盘,可正常传入该参数。​
  • 多个云盘之间用&分隔。​
​
ExtraPerformanceIOPS integer 示例值:1​
云盘额外IOPS性能大小,仅ESSD FlexPL数据盘支持,单位为次/秒。 ExtraPerformanceTypeId为Balance或IOPS时需设置该参数。各个类型的额外性能取值范围如下:​
  • IOPS型:1~50000。​
  • Balance型:1~50000。​
说明​
  • 参数 - N:表示云盘的序号,取值范围:1~16。N = 1表示系统盘,故N传入1时,该参数将被忽略。N ≥ 2表示数据盘,可正常传入该参数。​
  • 多个云盘之间用&分隔。​
​
ExtraPerformanceThroughputMB integer 示例值:1​
云盘额外吞吐性能大小,单位MB/s,仅ESSD FlexPL数据盘支持。 ExtraPerformanceTypeId为Throughput时需设置该参数。 取值范围:1~650。​
说明​
  • 参数 - N:表示云盘的序号,取值范围:1~16。N = 1表示系统盘,故N传入1时,该参数将被忽略。N ≥ 2表示数据盘,可正常传入该参数。​
  • 多个云盘之间用&分隔。​
​
SnapshotId string 示例值:snap-31ak39j5bh8rubsn****​
使用快照创建云盘,仅支持创建数据盘。您可以调用DescribeSnapshots接口查询快照ID。​
  • 参数 - N:表示云盘的序号,取值范围:1~16。N = 1表示系统盘,故N传入1时,该参数将被忽略。N ≥ 2表示数据盘,可正常传入目标数据盘快照ID。​
  • 多个云盘之间用&分隔。​
说明​
  • 仅极速型SSD支持通过快照创建云盘,性能型SSD不支持快照相关功能。​
  • 仅状态为“可用”的快照支持创建新云盘,“创建中”、“回滚中”、“删除中”及“错误”状态下的快照不支持创建新云盘。​
​
​
NetworkInterfaces object[]​
实例挂载的网卡信息。​
SubnetId string 示例值:subnet-3tispp1nai4e8i****​
子网ID。​
​
SecurityGroupIds string[] 示例值:[sg-3ti78x9h8t4bw*****,sg-3cj59ih2v9hj46c6rr******]​
安全组ID。​
​
​
Eip object​
实例绑定的公网IP信息。​
Bandwidth integer 示例值:1​
公网IP的带宽上限,单位:Mbps。​
  • 取值范围:1~200。​
  • 默认值:1。​
​
ISP string 示例值:BGP​
公网IP的线路类型,取值:​
  • BGP:BGP(多线)。​
  • ChinaMobile:中国移动静态单线。​
  • ChinaTelecom:中国电信静态单线。​
  • ChinaUnicom:中国联通静态单线。​
​
SecurityProtectionTypes string[] 示例值:[AntiDDoS_Enhanced]​
公网IP的安全防护类型。取值:​
  • AntiDDoS_Enhanced:申请增强防护类型的公网IP,可加入到DDoS原生防护(企业版)实例。​
​
BandwidthPackageId string 示例值:bwp-2zeo05qre24nhrqpy****​
共享带宽包ID。​
​
SecurityProtectionInstanceId integer 示例值:151​
安全防护包ID。​
​
BillingType integer 示例值:2​
公网IP的计费方式,取值:​
  • 2:按量计费-按带宽上限计费。​
  • 3:按量计费-按实际流量计费。​
​
ReleaseWithInstance boolean 示例值:false​
公网IP是否随实例删除,仅按量计费公网IP生效。取值:​
  • true:公网IP随实例删除。当实例被系统自动回收(退订24小时后、到期回收等)或被调用DeleteInstance、DeleteInstances接口删除时,公网IP随实例一同释放。​
  • false(默认):公网IP不随实例删除。​
​
​
Tags object[]​
实例的标签信息。​
Key string 示例值:keydemo​
实例的标签键。​
​
Value string 示例值:valuedemo​
实例的标签值。​
​
​
ScheduledInstance object​
弹性预约单信息。​
ScheduledInstanceName string 示例值:ESI-Name​
弹性预约单的名称。​
​
ScheduledInstanceDescription string 示例值:this is a test order​
弹性预约单的描述。​
​
​
DeploymentSetId string 示例值:dps-yc1o9aahks5m57nk****​
实例需要加入的部署集ID。​
​
DeploymentSetGroupNumber integer 示例值:1​
当ECS实例要加入或调整的部署集策略为部署集组高可用策略(AvailabilityGroup)时,可以通过该参数指定实例在部署集中的分组号。​
​
KeepImageCredential boolean 示例值:false​
是否保留镜像设置,取值:​
  • true:保留镜像设置,保留后将使用镜像预设的密码或密钥对登录实例。​
  • false(默认):不保留镜像设置。​
说明​
  • 仅自定义镜像、共享镜像支持该功能。​
  • 该参数取值为true时,请勿传入KeyPairName。​
​
​
CreatedAt string 示例值:2022-04-10T18:29:38+08:00​
实例启动模板的创建时间。​
​
UpdatedAt string 示例值:2022-04-14T18:29:38+08:00​
实例启动模板的更新时间。​
​
VersionNumber integer 示例值:1​
模板版本号。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeLaunchTemplateVersions&Version=2020-04-01&LaunchTemplateId=lt-ysxc16auaugh9zfy**** HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
ServiceName: ecs​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202401301658273AB316284D07320****",​
"Action": "DescribeLaunchTemplateVersions",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"NextToken": "",​
"LaunchTemplateVersions": [​
{​
"LaunchTemplateId": "lt-ysxc16auaugh9zfy****",​
"VersionNumber": 1,​
"VersionDescription": "",​
"LaunchTemplateVersionData": {​
"ZoneId": "",​
"InstanceTypeId": "ecs.t2-c1m1.large",​
"ImageId": "image-yco8plt02em0t*******",​
"InstanceChargeType": "",​
"InstanceName": "for-test",​
"Description": "",​
"HostName": "test",​
"UniqueSuffix": true,​
"SuffixIndex": 1,​
"KeyPairName": "******",​
"SecurityEnhancementStrategy": "InActive",​
"UserData": "ZWNobyBoZWxsbyxxxxxxx",​
"HpcClusterId": "",​
"Volumes": [​
{​
"VolumeType": "ESSD_PL0",​
"Size": 40,​
"DeleteWithInstance": false​
},​
{​
"VolumeType": "ESSD_PL0",​
"Size": 40,​
"DeleteWithInstance": false​
}​
],​
"NetworkInterfaces": [​
{​
"SubnetId": "subnet-imc2pmpasbuo8gbssz******",​
"SecurityGroupIds": [​
"sg-2ff4fhdtlo8ao59gp67******"​
]​
}​
],​
"Eip": {​
"Bandwidth": 1,​
"ISP": "BGP",​
"BillingType": 3,​
"BandwidthPackageId": "",​
"SecurityProtectionTypes": [],​
"SecurityProtectionInstanceId": 0​
},​
"VpcId": "",​
"ProjectName": "",​
"Tags": [],​
"SpotStrategy": "",​
"SpotPriceLimit": 0,​
"ScheduledInstance": {​
"ScheduledInstanceName": "",​
"ScheduledInstanceDescription": ""​
}​
},​
"CreatedAt": "2024-03-22T14:24:48+08:00",​
"UpdatedAt": "2024-03-22T14:24:48+08:00"​
}​
]​
}​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
​
最近更新时间:2026.01.09 16:40:43
这个页面对您有帮助吗?
有用
有用
无用
无用