文档

CreateLaunchTemplateVersion - 根据实例启动模板创建版本

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:CreateLaunchTemplateVersionWrite
  • LaunchTemplate
    acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
LaunchTemplateIdstring

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

lt-m5eiaupmvm2op9d****
LaunchTemplateNamestring

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

testLaunchTemplateName
VersionDescriptionstring

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

testVersionDescription
ImageIdstring

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

win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd
ImageOwnerAliasstring

镜像来源。

说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。
system
PasswordInheritboolean

是否使用镜像预设的密码。取值范围:

  • true。
  • false。

默认值:false。

说明 使用该参数时,Password 参数必须为空。同时您需要确保使用的镜像已经设置了密码。
false
InstanceTypestring

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

ecs.g5.large
SecurityGroupIdstring

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

说明 不支持同时指定SecurityGroupIdSecurityGroupIds.N
sg-bp15ed6xe1yxeycg****
VpcIdstring

专有网络 VPC ID。

vpc-bp12433upq1y5scen****
VSwitchIdstring

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

vsw-bp1s5fnvk4gn2tws0****
InstanceNamestring

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

testInstanceName
Descriptionstring

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

testDescription
InternetMaxBandwidthIninteger

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

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

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

5
HostNamestring

云服务器的主机名。

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

实例所属的可用区 ID。

cn-hangzhou-g
SystemDisk.Categorystring

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

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

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

cloud_ssd
SystemDisk.Sizeinteger

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

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

40
SystemDisk.DiskNamestring

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

cloud_ssdSystem
SystemDisk.Descriptionstring

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

testSystemDiskDescription
SystemDisk.Iopsinteger
说明 该参数暂未开放使用。
30000
SystemDisk.PerformanceLevelstring

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

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

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

PL0
SystemDisk.DeleteWithInstanceboolean

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

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

默认值:true。

true
SystemDisk.AutoSnapshotPolicyIdstring

系统盘采用的自动快照策略 ID。

sp-bp1dgzpaxwc4load****
SystemDisk.ProvisionedIopslong

是否修改 ESSD AutoPL 云盘预配置读写 IOPS。取值范围:0~min{50000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50,000}。

说明 当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘修改 ESSD AutoPL 云盘预配置信息
50000
SystemDisk.BurstingEnabledboolean

是否开启 Burst(性能突发)。取值范围:

  • true:是。
  • false:否。
true
IoOptimizedstring

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

  • none:非 I/O 优化。
  • optimized:I/O 优化。
optimized
InstanceChargeTypestring

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

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

购买资源的时长,单位为:月。当参数InstanceChargeType取值为PrePaid时该参数才生效且为必选值。取值范围:1、2、3、4、5、6、7、8、9、12、24、36、48、60。

1
InternetChargeTypestring

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

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

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

false
NetworkTypestring

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

  • classic:经典网络。
  • vpc:专有网络 VPC。
vpc
UserDatastring

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

ZWNobyBoZWxsbyBl****
KeyPairNamestring

密钥对名称。

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

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

testRamRoleName
AutoReleaseTimestring

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

  • 如果秒(ss)取值不是00,则自动取为当前分钟(mm)开始时。

  • 最短释放时间为当前时间半小时之后。

  • 最长释放时间不能超过当前时间三年。

2018-01-01T12:05:00Z
SpotStrategystring

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

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

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

0.97
SpotDurationinteger

抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:

  • 1:创建后阿里云会保证实例运行 1 小时不会被自动释放;超过 1 小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。
  • 0:创建后,阿里云不保证实例运行 1 小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。

实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。

说明 当 SpotStrategy 值为 SpotWithPriceLimit 或 SpotAsPriceGo 时该参数生效。
1
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4p****
SecurityEnhancementStrategystring

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

  • Active:启用安全加固,只对公共镜像生效。
  • Deactive:不启用安全加固,对所有镜像类型生效。
Active
PrivateIpAddressstring

实例私网 IP 地址。

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

10.1.**.**
Ipv6AddressCountinteger

为主网卡指定随机生成的 IPv6 地址数量。取值范围为 1~10。

1
DeploymentSetIdstring

部署集 ID。

ds-bp1brhwhoqinyjd6****
DataDiskobject []

数据盘列表。

PerformanceLevelstring

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

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

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

PL1
Descriptionstring

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

testDataDiskDescription
SnapshotIdstring

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

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

s-bp17441ohwka0yuh****
Sizeinteger

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

  • cloud:5~2000。
  • cloud_efficiency:20~32768。
  • cloud_ssd:20~32768。
  • cloud_essd:具体取值范围与DataDisk.N.PerformanceLevel的取值有关。
    • PL0:40~32768。
    • PL1:20~32768。
    • PL2:461~32768。
    • PL3:1261~32768。

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

2000
Devicestring
说明 该参数即将废弃,不建议使用。
null
DiskNamestring

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

testDataDiskName
Categorystring

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

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

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

cloud_ssd
DeleteWithInstanceboolean

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

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

默认值:true。

true
Encryptedstring

数据盘是否加密。

false
ProvisionedIopslong

是否修改 ESSD AutoPL 云盘预配置读写 IOPS。取值范围:0~min{50000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50,000}。

说明 当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘修改 ESSD AutoPL 云盘预配置信息
50000
BurstingEnabledboolean

是否开启 Burst(性能突发)。取值范围:

  • true:是。
  • false:否。
true
AutoSnapshotPolicyIdstring

数据盘采用的自动快照策略 ID。

sp-bp67acfmxazb4p****
NetworkInterfaceobject []

弹性网卡信息。

VSwitchIdstring

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

vsw-bp1s5fnvk4gn2tws0****
NetworkInterfaceNamestring

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

testNetworkInterfaceName
Descriptionstring

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

testNetworkInterfaceDescription
SecurityGroupIdstring

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

说明 不支持同时指定NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
sg-bp15ed6xe1yxeycg****
PrimaryIpAddressstring

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

192.168.**.**
SecurityGroupIdsarray

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

说明 不支持同时指定NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
string

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

说明 不支持同时指定NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
sg-bp67acfmxazb4p****
InstanceTypestring

弹性网卡类型。N 的取值范围为 1~2,设置 1 个弹性网卡时,支持设置 1 个主网卡或 1 个辅助网卡;设置 2 个弹性网卡时,仅支持同时设置 1 个主网卡和 1 个辅助网卡。

参数取值范围:

  • Primary:主网卡。
  • Secondary:辅助网卡。

默认值:Secondary。

Secondary
NetworkInterfaceTrafficModestring

主网卡的通讯模式。取值范围:

  • Standard:使用 TCP 通讯模式。
  • HighPerformance:开启 ERI(Elastic RDMA Interface)接口,使用 RDMA 通讯模式。
Standard
Tagobject []

标签列表。

Keystring

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

TestKey
Valuestring

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

TestValue
SecurityGroupIdsarray

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

说明 不支持同时指定SecurityGroupIdSecurityGroupIds.N
string

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

说明 不支持同时指定SecurityGroupIdSecurityGroupIds.N
sg-bp15ed6xe1yxeycg7****
SystemDisk.Encryptedstring

系统盘是否加密。取值范围:

  • true:加密。

  • false:不加密。

默认值:false。

说明 中国香港 D 可用区、新加坡 A 可用区暂不支持在创建实例时加密系统盘。
false
DeletionProtectionboolean

实例释放保护属性,指定是否支持通过控制台或 API( DeleteInstance )释放实例。取值范围:

  • true:开启实例释放保护。

  • false:关闭实例释放保护。

默认值:false。

说明 该属性仅适用于按量付费实例,且只能限制手动释放操作,对系统释放操作不生效。
false
CreditSpecificationstring

设置突发性能实例的运行模式。取值范围:

Standard

返回参数

名称类型描述示例值
object
LaunchTemplateVersionNumberlong

实例启动模板版本号。

2
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DEX****
LaunchTemplateIdstring

启动模板 ID。更多信息,请参见 DescribeLaunchTemplates

使用启动模板创建实例时,您必须指定LaunchTemplateIdLaunchTemplateName以确定启动模板。

lt-bp1apo0bbbkuy0rj****

示例

正常返回示例

JSON格式

{
  "LaunchTemplateVersionNumber": 2,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DEX****",
  "LaunchTemplateId": "lt-bp1apo0bbbkuy0rj****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegion.NotExist%s指定的地域不存在,请确认参数是否正确。
400MissingParameter%s缺失参数,请检查参数是否完整。
400InvalidParameter%s无效的参数。
400InvalidDescription.MalformedThe specified parameter "Description" is not valid.指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。
400InvalidUserData.SizeExceeded%s您设置的数据大小超过了允许的最大值。
400InvalidUserData.Base64FormatInvalid%s您设置的数据格式不正确,请选择规定的格式数据。
400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
400InvalidParams.CreateEniParams%s-
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
403LaunchTemplateVersionLimitExceed%s超出启动模版版本限制。
404InvalidLaunchTemplate.NotFound%s没有找到指定的启动模版,请检查参数是否正确。
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.资源组并不在记录中。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

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

变更历史

变更时间变更内容概要操作
2023-10-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:CreditSpecification
2023-08-01OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:DeletionProtection
2023-03-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2022-07-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:SystemDisk.AutoSnapshotPolicyId
    新增入参:SystemDisk.ProvisionedIops
    新增入参:SystemDisk.BurstingEnabled
2021-12-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Ipv6AddressCount
  • 本页导读 (1)
文档反馈