调用CreateLaunchTemplateVersion根据指定的ECS实例启动模板创建一个版本。

接口说明

当您想修改某个版本的参数时,能通过新建模板版本的方式修改。每个实例启动模板最多创建30个版本。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateLaunchTemplateVersion

系统规定参数。取值:CreateLaunchTemplateVersion

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

LaunchTemplateId String lt-m5eiaupmvm2op9d****

启动模板ID。更多详情,请调用DescribeLaunchTemplates。您必须指定LaunchTemplateIdLaunchTemplateName以确定启动模板。

LaunchTemplateName String testLaunchTemplateName

实例启动模板名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

VersionDescription String testVersionDescription

实例启动模板版本的描述。长度为2~256个英文或中文字符,不能以http://和https://开头。

ImageId String win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd

镜像ID,启动实例时选择的镜像资源。您可以通过DescribeImages查询您可以使用的镜像资源。

ImageOwnerAlias String system

镜像来源。

说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。
InstanceType String ecs.g5.large

实例的资源规格。更多详情,请参见实例规格族,也可以调用DescribeInstanceTypes接口获得最新的规格表。

SecurityGroupId String sg-bp15ed6xe1yxeycg****

指定新创建实例所属于的安全组ID。同一个安全组内的实例之间可以互相访问。

说明 不支持同时指定SecurityGroupIdSecurityGroupIds.N
VpcId String vpc-bp12433upq1y5scen****

专有网络VPC ID。

VSwitchId String vsw-bp1s5fnvk4gn2tws0****

创建VPC类型实例时需要指定虚拟交换机ID。

InstanceName String testInstanceName

实例名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

Description String testDescription

实例描述。长度为2~256个英文或中文字符,不能以http://和https://开头。

InternetMaxBandwidthIn Integer 50

公网入带宽最大值,单位为Mbit/s。取值范围:

  • 当所购公网出带宽小于等于10Mbit/s时:1~10,默认为10。
  • 当所购公网出带宽大于10Mbit/s时:1~InternetMaxBandwidthOut的取值,默认为InternetMaxBandwidthOut的取值。
InternetMaxBandwidthOut Integer 5

公网出带宽最大值,单位为Mbit/s。取值范围:0~100

HostName String testHostName

云服务器的主机名。

  • 点号(.)和短横线(-)不能作为首尾字符,更不能连续使用。
  • Windows实例:字符长度为2~15,不支持点号(.),不能全是数字。允许大小写英文字母、数字和短横线(-)。
  • 其他类型实例(Linux等):字符长度为2~64,支持多个点号(.),点之间为一段,每段允许大小写英文字母、数字和短横线(-)。
ZoneId String cn-hangzhou-g

实例所属的可用区ID。

SystemDisk.Category String cloud_ssd

系统盘的云盘种类。取值范围:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • cloud_essd:ESSD云盘。您可以通过参数SystemDisk.PerformanceLevel设置云盘的性能等级。

已停售的实例规格且非I/O优化实例默认值为cloud,否则默认值为cloud_efficiency。

SystemDisk.Size Integer 40

系统盘大小,单位为GiB。取值范围:20~500

该参数的取值必须大于或者等于max{20, ImageSize}。

SystemDisk.DiskName String cloud_ssdSystem

系统盘名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

SystemDisk.Description String testSystemDiskDescription

系统盘描述。长度为2~256个英文或中文字符,不能以http://和https://开头。

SystemDisk.PerformanceLevel String PL0

创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:

  • PL0(默认):单盘最高随机读写IOPS 1万
  • PL1:单盘最高随机读写IOPS 5万
  • PL2:单盘最高随机读写IOPS 10万
  • PL3:单盘最高随机读写IOPS 100万

有关如何选择ESSD性能等级,请参见ESSD云盘

SystemDisk.DeleteWithInstance Boolean true

系统盘是否随实例释放。取值范围:

  • true:随实例释放
  • false:不随实例释放

默认值:true

DataDisk.N.Size Integer 2000

第n个数据盘的容量大小,n的取值范围为1~16,内存单位为GiB。取值范围:

  • cloud:5~2000
  • cloud_efficiency:20~32768
  • cloud_ssd:20~32768
  • cloud_essd:20~32768

该参数的取值必须大于等于参数SnapshotId指定的快照的大小。

DataDisk.N.SnapshotId String s-bp17441ohwka0yuh****

创建数据盘n使用的快照。n的取值范围为1~16。指定参数DataDisk.N.SnapshotId后,参数DataDisk.N.Size会被忽略,实际创建的云盘大小为指定的快照的大小。

不能使用早于2013年7月15日(含)创建的快照,请求会报错被拒绝。

DataDisk.N.Category String cloud_ssd

数据盘n的云盘种类。取值范围:

  • cloud:普通云盘
  • cloud_efficiency:高效云盘
  • cloud_ssd:SSD云盘
  • cloud_essd:ESSD云盘

I/O优化实例的默认值为cloud_efficiency,非I/O优化实例的默认值为cloud。

DataDisk.N.Encrypted String false

数据盘是否加密。

DataDisk.N.DiskName String testDataDiskName

数据盘名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

DataDisk.N.Description String testDataDiskDescription

实例描述。长度为2~256个英文或中文字符,不能以http://和https://开头。

DataDisk.N.DeleteWithInstance Boolean true

表示数据盘是否随实例释放。取值范围:

  • true:随实例释放
  • false:不随实例释放

默认值:true

DataDisk.N.PerformanceLevel String PL1

创建ESSD云盘作为数据盘使用时,设置云盘的性能等级。N的取值必须和DataDisk.N.Category=cloud_essd中的N保持一致。取值范围:

  • PL0:单盘最高随机读写IOPS 1万
  • PL1(默认):单盘最高随机读写IOPS 5万
  • PL2:单盘最高随机读写IOPS 10万
  • PL3:单盘最高随机读写IOPS 100万

有关如何选择ESSD性能等级,请参见ESSD云盘

IoOptimized String optimized

是否为I/O优化实例。取值范围:

  • none:非I/O优化
  • optimized:I/O优化
NetworkInterface.N.PrimaryIpAddress String 192.168.**.**

辅助弹性网卡的主私有IP地址。NetworkInterface.N的N取值不能大于1。

NetworkInterface.N.VSwitchId String vsw-bp1s5fnvk4gn2tws0****

辅助弹性网卡所属的虚拟交换机ID。实例与辅助弹性网卡必须在同一VPC的同一可用区中,可以分属于不同交换机。NetworkInterface.N的N取值不能大于1。

NetworkInterface.N.SecurityGroupId String sg-bp15ed6xe1yxeycg****

辅助弹性网卡所属安全组的ID。辅助弹性网卡的安全组和实例的安全组必须在同一个VPC下。NetworkInterface.N的N取值不能大于1。

说明 不支持同时指定NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
NetworkInterface.N.NetworkInterfaceName String testNetworkInterfaceName

辅助弹性网卡名称。NetworkInterface.N的N取值不能大于1。

NetworkInterface.N.Description String testNetworkInterfaceDescription

辅助弹性网卡描述信息。长度为2~256个英文或中文字符,不能以http://https://开头。NetworkInterface.N的N取值不能大于1。

NetworkInterface.N.SecurityGroupIds.N RepeatList sg-bp67acfmxazb4p****

辅助弹性网卡加入的一个或多个安全组。安全组和辅助弹性网卡必须在同一个专有网络VPC中。SecurityGroupIds.N的N取值范围与辅助弹性网卡能够加入安全组配额有关。更多信息,请参见使用限制NetworkInterface.N的N取值不能大于1。

说明 不支持同时指定NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
InstanceChargeType String PrePaid

实例的计费方式。取值范围:

  • PrePaid:包年包月。选择该类计费方式时,您必须确认自己的账号支持信用支付,否则将返回InvalidPayMethod的错误提示。
  • PostPaid:按量付费。
Period Integer 1

购买资源的时长,单位为:月。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。一旦指定了DedicatedHostId,则取值范围不能超过专有宿主机的订阅时长。取值范围:

  • PeriodUnit=Week时,Period取值:{“1”, “2”, “3”, “4”}
  • PeriodUnit=Month时,Period取值:{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”, ”48”, ”60”}
InternetChargeType String PayByTraffic

公网出方向带宽计费方式。取值范围:

  • PayByBandwidth:按固定带宽计费
  • PayByTraffic:按使用流量计费
说明 按使用流量计费模式下的出入带宽峰值都是带宽上限,不作为业务承诺指标。当出现资源争抢时,带宽峰值可能会受到限制。如果您的业务需要有带宽的保障,请使用按固定带宽计费模式。
EnableVmOsConfig Boolean false

是否启用实例操作系统配置。

NetworkType String vpc

实例网络类型。取值范围:

  • classic
  • vpc
UserData String ZWNobyBoZWxsbyBl****

实例自定义数据,需要以Base64方式编码,原始数据最多为16KB。

KeyPairName String testKeyPairName

密钥对名称。

  • Windows实例,忽略该参数。即使填写了该参数,仍旧只执行Password的内容。
  • Linux实例的密码登录方式会被初始化成禁止。
RamRoleName String testRamRoleName

实例RAM角色名称。您可以使用RAM API ListRoles查询您已创建的实例RAM角色。

AutoReleaseTime String 2018-01-01T12:05:00Z

自动释放时间。按照ISO8601标准表示,并需要使用UTC时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

  • 如果秒(ss)取值不是00,则自动取为当前分钟(mm)开始时。
  • 最短释放时间为当前时间半小时之后。
  • 最长释放时间不能超过当前时间三年。
SpotStrategy String NoSpot

按量实例的抢占策略。当参数InstanceChargeType取值为PostPaid时生效。取值范围:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
SpotPriceLimit Float 0.97

设置实例的每小时最高价格。支持最大3位小数。

SpotDuration Integer 1

抢占式实例的保留时长,单位为小时。取值范围:0~6

  • 保留时长2~6正在邀测中,如需开通请提交工单。
  • 取值为0,则为无保护期模式。

默认值:1

ResourceGroupId String rg-bp67acfmxazb4p****

资源组ID。

SecurityEnhancementStrategy String Active

是否为操作系统开启安全加固。取值范围:

  • Active:启用安全加固,只对公共镜像生效。
  • Deactive:不启用安全加固,对所有镜像类型生效。
Tag.N.Key String TestKey

实例、块存储和主网卡的标签键。N的取值范围:1~5。一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

Tag.N.Value String TestValue

实例、块存储和主网卡的标签值。N的取值范围:1~5。一旦传入该值,可以为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

SecurityGroupIds.N RepeatList sg-bp15ed6xe1yxeycg7****

实例加入的一个或多个安全组。N的取值范围与实例能够加入安全组配额有关。更多信息,使用限制

说明 不支持同时指定SecurityGroupIdSecurityGroupIds.N
PrivateIpAddress String 10.1.**.**

实例私网IP地址。

专有网络VPC类型ECS实例设置私网IP地址时,必须从虚拟交换机(VSwitchId)的空闲网段中选择。

返回数据

名称 类型 示例值 描述
LaunchTemplateVersionNumber Long 2

实例启动模板版本号。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=CreateLaunchTemplateVersion
&RegionId=cn-hangzhou
&LaunchTemplateId=lt-m5eiaupmvm2op9d****
&LaunchTemplateName=testLaunchTemplateName
&VersionDescription=testVersionDescription
&ImageId=win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd
&InstanceType=ecs.g5.large
&SecurityGroupId=sg-bp15ed6xe1yxeycg****
&VpcId=vpc-bp12433upq1y5scen****
&VSwitchId=vsw-bp1s5fnvk4gn2tws0****
&InstanceName=testInstanceName
&Description=testDescription
&InternetMaxBandwidthIn=50
&InternetMaxBandwidthOut=5
&HostName=testHostName
&ZoneId=cn-hangzhou-g
&SystemDisk.Category=cloud_ssd
&SystemDisk.Size=40
&SystemDisk.DiskName=testSystemDiskName
&SystemDisk.Description=testSystemDiskDescription
&DataDisk.1.Size=2000
&DataDisk.1.SnapshotId=s-bp17441ohwka0yuh****
&DataDisk.1.Category=cloud_ssd
&DataDisk.1.Encrypted=false
&DataDisk.1.DiskName=cloud_ssdData
&DataDisk.1.Description=testDataDiskDescription
&DataDisk.1.DeleteWithInstance=true
&IoOptimized=optimized
&NetworkInterface.1.PrimaryIpAddress=192.168.**.**
&NetworkInterface.1.VSwitchId=vsw-bp1s5fnvk4gn2tws0****
&NetworkInterface.1.SecurityGroupId=sg-bp15ed6xe1yxeycg****
&NetworkInterface.1.NetworkInterfaceName=testNetworkInterfaceName
&NetworkInterface.1.Description=testNetworkInterfaceDescription
&PrivateIpAddress=10.1.**.**
&InstanceChargeType=PrePaid
&Period=1
&InternetChargeType=PayByTraffic
&NetworkType=vpc
&UserData=ZWNobyBoZWxsbyBl****
&RamRoleName=testRamRoleName
&AutoReleaseTime=2020-02-02T12:05:00Z
&SpotStrategy=NoSpot
&SpotPriceLimit=0.97
&SecurityEnhancementStrategy=Active
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&<公共请求参数>

正常返回示例

XML 格式

<CreateLaunchTemplateVersionResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
      <LaunchTemplateVersionNumber>2</LaunchTemplateVersionNumber>
</CreateLaunchTemplateVersionResponse>

JSON 格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FExxxxx",
    "LaunchTemplateVersionNumber": 2
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegion.NotExist %s 指定的地域不存在,请确认参数是否正确。
403 LaunchTemplateVersionLimitExceed %s 超出启动模版版本限制。
404 InvalidLaunchTemplate.NotFound %s 没有找到指定的启动模版,请检查参数是否正确。
400 MissingParameter %s 缺失参数,请检查参数是否完整。
400 InvalidParameter %s 无效的参数。
400 InvalidDescription.Malformed The specified parameter "Description" is not valid. 指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。
400 InvalidUserData.SizeExceeded %s 您设置的数据大小超过了允许的最大值。
400 InvalidUserData.Base64FormatInvalid %s 您设置的数据格式不正确,请选择规定的格式数据。
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records. 资源组并不在记录中。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单。
400 InvalidHostName.Malformed The specified parameter "HostName" is not valid. 指定的HostName格式不合法。

访问错误中心查看更多错误码。