文档

CreateLaunchTemplate - 创建实例启动模板

更新时间:

调用CreateLaunchTemplate接口,并可以指定TemplateTag、LaunchTemplateName、ImageId等参数,创建一个ECS实例启动模板,简称模板。实例启动模板能免除每次创建实例时都需要填入大量配置参数。

接口说明

调用 CreateLaunchTemplate 创建模板后,会自动生成该模板的一个默认版本,版本号为 1,您后续可以基于该模板创建多个版本(CreateLaunchTemplateVersion),版本号从 1 开始顺序递增。如果您在创建实例( RunInstances )时不指定模板版本号,会采用默认版本。

实例启动模板的版本中包含用于创建实例的相关配置,例如实例所属地域、镜像 ID、实例规格、安全组 ID 和公网带宽等。如果版本中没有指定某一实例配置,您需要在创建实例时为实例指定该配置。

调用该接口时,您需要注意:

  • 每个账号在一个地域最多能创建 30 个实例启动模板,且每个模板最多能有 30 个版本。

  • 实例启动模板的参数大多数为可选参数。创建模板时,阿里云不会验证模板中参数取值的存在性和有效性。只会在真正创建实例时校验参数取值的有效性。

  • 如果实例启动模板中设置了某一配置,创建实例( RunInstances )时就无法过滤掉该配置。例如,如果模板设置了HostName=LocalHostRunInstancesHostName取值为空时,实例的主机名依然是LocalHost。如果您想覆盖HostName=LocalHost这一配置,可以在RunInstances中取HostName=MyHost或其他参数值。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
TemplateTagarray<object>

启动模版自身的标签对信息。

说明 当前仅支持通过 API 创建和查询启动模板的标签,控制台无法创建或查看。
object

启动模版自身的标签对信息。

Keystring

启动模板的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

TestKey
Valuestring

启动模板的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

TestValue
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:阿里云提供的公共镜像。
  • self:您创建的自定义镜像。
  • others:其他阿里云用户共享给您的镜像。
  • marketplace:云市场提供的镜像。您查询到的云市场镜像可以直接使用,无需提前订阅。您需要自行留意云市场镜像的收费详情。
system
PasswordInheritboolean

是否使用镜像预设的密码。

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

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

ecs.g5.large
SecurityGroupIdstring

指定新创建实例所属于的安全组 ID。同一个安全组内的实例之间可以互相访问,一个安全组最多能管理 1000 台实例。

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

专有网络 VPC ID。

vpc-bp12433upq1y5scen****
VSwitchIdstring

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

vsw-bp1s5fnvk4gn2tws0****
InstanceNamestring

实例名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。默认值为实例的InstanceId

创建多台 ECS 实例时,您可以批量设置有序的实例名称,并且可以包含方括号([])和逗号(,)。具体操作,请参见批量设置有序的实例名称或主机名称

k8s-node-[1,4]-alibabacloud
Descriptionstring

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

testECSDescription
InternetMaxBandwidthIninteger

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

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

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

10
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设置云盘的性能等级。
  • cloud_auto:ESSD AutoPL 云盘
  • cloud_essd_entry:ESSD Entry 云盘。

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

cloud_ssd
SystemDisk.Sizeinteger

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

  • cloud:20~500。
  • 其他云盘种类:20~2048。

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

40
SystemDisk.DiskNamestring

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

testSystemDiskName
SystemDisk.Descriptionstring

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

testSystemDiskDescription
SystemDisk.Iopsinteger
说明 该参数正在邀测中,暂未开放使用。
null
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-gc7c37d4ylw7mtnk****
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 方式编码,原始数据最多为 32 KB。

ZWNobyBoZWxsbyBlY3Mh
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 位小数,参数SpotStrategy取值为SpotWithPriceLimit时生效。

0.97
SpotDurationinteger

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

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

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

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

实例、块存储和弹性网卡所在的企业资源组 ID。

rg-bp67acfmxazb4p****
TemplateResourceGroupIdstring

启动模板所在的企业资源组 ID。

rg-bp67acfmxazb4p****
SecurityEnhancementStrategystring

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

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

实例私网 IP 地址。

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

10.1.**.**
DeploymentSetIdstring

部署集 ID。

ds-bp1brhwhoqinyjd6****
Ipv6AddressCountinteger

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

1
DataDiskarray<object>

数据盘信息列表。

object

数据盘信息列表。

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:1~32768。
    • PL1:20~32768。
    • PL2:461~32768。
    • PL3:1261~32768。
  • cloud_auto:1~32,768。
  • cloud_essd_entry:10~32,768。

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

2000
Devicestring

数据盘的挂载点。挂载的数据盘数量不同,挂载点的命名不同:

  • 1~25 块数据盘:/dev/xvd[b-z]

  • 大于 25 块数据盘:/dev/xvd[aa-zz],例如第 26 块数据盘会被命名为/dev/xvdaa,第 27 块数据盘为/dev/xvdab,以此类推。

说明 该参数仅用于全镜像(整机镜像)场景。您可以通过将此参数设置为全镜像中数据盘对应的挂载点,并修改对应的DataDisk.N.SizeDataDisk.N.Category参数,达到修改全镜像中数据盘磁盘种类和大小的目的。
/dev/xvdb
DiskNamestring

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

testDataDiskName
Categorystring

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

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud_auto:ESSD AutoPL 云盘
  • cloud_essd_entry:ESSD Entry 云盘。

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

cloud_ssd
DeleteWithInstanceboolean

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

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

默认值:true。

true
Encryptedstring

数据盘是否加密。

false
AutoSnapshotPolicyIdstring

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

sp-m5e7fa9ute44ssa****
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
NetworkInterfacearray<object>

弹性网卡信息。

object

弹性网卡信息。

VSwitchIdstring

弹性网卡所属的虚拟交换机 ID。

您需要注意:

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

  • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数。此时该参数的作用等同于VSwitchId,但需要注意不能同时设置VSwitchId参数。

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的虚拟交换机。

vsw-bp1s5fnvk4gn2tws0****
NetworkInterfaceNamestring

弹性网卡名称。

您需要注意:

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

  • 如果NetworkInterface.N.InstanceType取值为Primary,则无需设置该参数。

testEniName
Descriptionstring

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

testEniDescription
SecurityGroupIdstring

弹性网卡所属的安全组 ID。

您需要注意:

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

  • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数。此时该参数的作用等同于SecurityGroupId,但需要注意不能再设置SecurityGroupIdSecurityGroupIds.NNetworkInterface.N.SecurityGroupIds.N

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的安全组。

sg-bp15ed6xe1yxeycg****
PrimaryIpAddressstring

添加一张弹性网卡并设置主 IP 地址。

您需要注意:

  • N 的取值范围为 1~2:

    • 设置 1 个弹性网卡时,支持设置 1 个主网卡或 1 个辅助网卡。如果Amount参数取值大于 1,且设置了主网卡并设置了该参数,则表示在批量创建 ECS 实例时,以指定的主 IP 地址为起始地址,依次为多台 ECS 实例分配连续的主 IP 地址,但需要注意,此时不支持再为实例绑定辅助网卡。
    • 设置 2 个弹性网卡时,仅支持同时设置 1 个主网卡和 1 个辅助网卡,但需要注意,如果Amount参数取值大于 1 且已为主网卡设置了该参数,则不支持再设置辅助网卡(即不支持再设置NetworkInterface.2.InstanceType=Secondary)。
  • 如果NetworkInterface.N.InstanceType取值为Primary,则该参数的作用等同于PrivateIpAddress,但需要注意不能同时设置PrivateIpAddress参数。

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,表示为辅助网卡设置主 IP 地址。默认从网卡所属的交换机网段中随机选择一个 IP 地址。

说明 创建 ECS 实例时,您最多能添加一张辅助网卡。实例创建成功后,您可以调用 CreateNetworkInterfaceAttachNetworkInterface 添加更多的辅助网卡。
192.168.**.**
SecurityGroupIdsarray

弹性网卡所属的一个或多个安全组 ID。

  • 第一个 N 的取值范围为 1~2,设置 1 个弹性网卡时,支持设置 1 个主网卡或 1 个辅助网卡;设置 2 个弹性网卡时,仅支持同时设置 1 个主网卡和 1 个辅助网卡。
  • 第二个 N 表示可以指定一个或多个安全组 ID。N 的取值范围与实例能够加入安全组配额有关,更多信息,请参见安全组限制

您需要注意:

  • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数或NetworkInterface.N.SecurityGroupId。此时该参数的作用等同于SecurityGroupIds.N,但需要注意不能再设置SecurityGroupIdSecurityGroupIds.NNetworkInterface.N.SecurityGroupId

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的安全组。

string

弹性网卡所属的一个或多个安全组 ID。

  • 第一个 N 的取值范围为 1~2,设置 1 个弹性网卡时,支持设置 1 个主网卡或 1 个辅助网卡;设置 2 个弹性网卡时,仅支持同时设置 1 个主网卡和 1 个辅助网卡。
  • 第二个 N 表示可以指定一个或多个安全组 ID。N 的取值范围与实例能够加入安全组配额有关,更多信息,请参见安全组限制

您需要注意:

  • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数或NetworkInterface.N.SecurityGroupId。此时该参数的作用等同于SecurityGroupIds.N,但需要注意不能再设置SecurityGroupIdSecurityGroupIds.NNetworkInterface.N.SecurityGroupId

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的安全组。

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
Tagarray<object>

通过该模板的版本创建的实例、云盘和主网卡的标签信息。

使用场景
通过调用 CreateLaunchTemplate 接口创建模版后,使用自动生成的默认版本来创建实例时,将使用此标签来标记实例、云盘和主网卡。
object

通过该模板的版本创建的实例、云盘和主网卡的标签信息。

Keystring

通过该模板的版本创建的实例、云盘和主网卡的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或 https://。

TestKey
Valuestring

通过该模板的版本创建的实例、云盘和主网卡的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含 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
AutoRenewboolean

是否要自动续费。取值范围:

  • true:自动续费。
  • false:不自动续费。

默认值:false。

说明 当参数InstanceChargeType取值PrePaid时才生效。
true
AutoRenewPeriodinteger

单次自动续费的续费时长。取值范围:

  • PeriodUnit=Week 时:1、2、3。
  • PeriodUnit=Month 时:1、2、3、6、12、24、36、48、60。

默认值:1。

1
PeriodUnitstring

包年包月计费方式的时长单位。取值范围:

  • Week。
  • Month(默认)。
Month

返回参数

名称类型描述示例值
object
LaunchTemplateIdstring

实例启动模板 ID。

lt-m5eiaupmvm2op9d****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
LaunchTemplateVersionNumberlong

实例启动模板版本号。

20

示例

正常返回示例

JSON格式

{
  "LaunchTemplateId": "lt-m5eiaupmvm2op9d****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "LaunchTemplateVersionNumber": 20
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegion.NotExist%s指定的地域不存在,请确认参数是否正确。
400MissingParameter%s缺失参数,请检查参数是否完整。
400InvalidParameter%s无效的参数。
400InvalidLaunchTemplateName.MalformedThe specified parameter LaunchTemplateName is not valid.指定的参数 LaunchTemplateName 无效。
400InvalidDescription.MalformedThe specified parameter "VersionDescription" is not valid.-
400InvalidUserData.SizeExceeded%s您设置的数据大小超过了允许的最大值。
400InvalidUserData.Base64FormatInvalid%s您设置的数据格式不正确,请选择规定的格式数据。
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
400InvalidParams.CreateEniParams%s-
403LaunchTemplateLimitExceed%s超出启动模版数量限制。
403LaunchTemplateName.Duplicated%s指定的启动模版名称已经存在。
403QuotaExceed.Tags%s标签数超过可以配置的最大数量。%s为变量,将根据调用API的实际情况动态返回错误信息。
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.资源组并不在记录中。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

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

变更历史

变更时间变更内容概要操作
2024-05-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-10-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-10-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-01OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-07-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2021-12-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情