- 地域
- 询价
- 实例
- 镜像
- 块存储
- 快照
- 网络
- 弹性网卡
- 前缀列表
- 端口列表
- 安全组
- 密钥对
- 启动模板
- 弹性供应组
- 部署集
- 资源保障
- 预留实例券
- 存储容量单位包
- 云助手
- 系统事件
- 资源诊断
- 运维与监控
- 标签与资源组
- 专有宿主机
- 高性能集群
- 任务
- Deprecated
接口说明
调用 CreateLaunchTemplate 创建模板后,会自动生成该模板的一个默认版本,版本号为 1,您后续可以基于该模板创建多个版本(CreateLaunchTemplateVersion
),版本号从 1 开始顺序递增。如果您在创建实例( RunInstances )时不指定模板版本号,会采用默认版本。
实例启动模板的版本中包含用于创建实例的相关配置,例如实例所属地域、镜像 ID、实例规格、安全组 ID 和公网带宽等。如果版本中没有指定某一实例配置,您需要在创建实例时为实例指定该配置。
调用该接口时,您需要注意:
-
每个账号在一个地域最多能创建 30 个实例启动模板,且每个模板最多能有 30 个版本。
-
实例启动模板的参数大多数为可选参数。创建模板时,阿里云不会验证模板中参数取值的存在性和有效性。只会在真正创建实例时校验参数取值的有效性。
-
如果实例启动模板中设置了某一配置,创建实例( RunInstances )时就无法过滤掉该配置。例如,如果模板设置了
HostName=LocalHost
,RunInstances
中HostName
取值为空时,实例的主机名依然是LocalHost
。如果您想覆盖HostName=LocalHost
这一配置,可以在RunInstances
中取HostName=MyHost
或其他参数值。
请求参数
字段名称 | 字段详情 |
---|---|
RegionIdstring | 地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
TemplateTagarray<object> | 启动模版自身的标签对信息。展开详情 子级条数 <= 20 |
LaunchTemplateNamestring | 实例启动模板名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 示例值:testLaunchTemplateName参考取值来源: DescribeLaunchTemplates |
VersionDescriptionstring | 实例启动模板的版本描述。长度为 2~256 个英文或中文字符,不能以 示例值:testVersionDescription |
ImageIdstring | 镜像 ID,启动实例时选择的镜像资源。您可以通过 DescribeImages 查询您可以使用的镜像资源。 示例值:win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd参考取值来源: ImportImage CopyImage CreateImage ExportImage DescribeImages |
ImageOwnerAliasstring | 镜像来源。取值范围:展开详情 示例值:system参考取值来源: DescribeImages |
PasswordInheritboolean | 是否使用镜像预设的密码。展开详情 示例值:false |
InstanceTypestring | 实例的资源规格。更多信息,请参见实例规格族,也可以调用 DescribeInstanceTypes 接口获得最新的规格表。 示例值:ecs.g5.large参考取值来源: DescribeInstanceTypes CreateInstance |
SecurityGroupIdstring | 指定新创建实例所属于的安全组 ID。同一个安全组内的实例之间可以互相访问,一个安全组最多能管理 1000 台实例。展开详情 示例值:sg-bp15ed6xe1yxeycg****参考取值来源: CreateSecurityGroup DescribeSecurityGroups |
VpcIdstring | 专有网络 VPC ID。 示例值:vpc-bp12433upq1y5scen**** |
VSwitchIdstring | 创建 VPC 类型实例时需要指定虚拟交换机 ID。 示例值:vsw-bp1s5fnvk4gn2tws0**** |
InstanceNamestring | 实例名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。默认值为实例的 示例值:k8s-node-[1,4]-alibabacloud参考取值来源: DescribeInstances ModifyManagedInstance DeregisterManagedInstance |
Descriptionstring | 实例描述。长度为 2~256 个英文或中文字符,不能以 示例值:testECSDescription |
InternetMaxBandwidthIninteger<int32> | 公网入带宽最大值,单位为 Mbit/s。取值范围:展开详情 示例值:10 |
InternetMaxBandwidthOutinteger<int32> | 公网出带宽最大值,单位为 Mbit/s。取值范围为 0~100。 示例值:10 |
HostNamestring | 云服务器的主机名。展开详情 示例值:testHostName |
ZoneIdstring | 实例所属的可用区 ID。 示例值:cn-hangzhou-g参考取值来源: DescribeZones |
SystemDisk.Categorystring | 系统盘的云盘种类。取值范围:展开详情 示例值:cloud_ssd |
SystemDisk.Sizeinteger<int32> | 系统盘大小,单位为 GiB。取值范围:展开详情 示例值:40 |
SystemDisk.DiskNamestring | 系统盘名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 示例值:testSystemDiskName参考取值来源: DescribeDisks |
SystemDisk.Descriptionstring | 系统盘描述。长度为 2~256 个英文或中文字符,不能以 示例值:testSystemDiskDescription |
SystemDisk.Iopsinteger<int32> | 说明
该参数正在邀测中,暂未开放使用。
示例值:null |
SystemDisk.PerformanceLevelstring | 创建 ESSD 云盘作为系统盘使用时,设置云盘的性能等级。取值范围:展开详情 示例值:PL0 |
SystemDisk.DeleteWithInstanceboolean | 系统盘是否随实例释放。取值范围:展开详情 示例值:true |
SystemDisk.AutoSnapshotPolicyIdstring | 系统盘采用的自动快照策略 ID。 示例值:sp-gc7c37d4ylw7mtnk****参考取值来源: DescribeAutoSnapshotPolicyEx CreateAutoSnapshotPolicy |
SystemDisk.ProvisionedIopsinteger<int64> | ESSD AutoPL 云盘预配置读写 IOPS。取值范围:0~min{50000, 1000*容量-基准性能}。展开详情 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:50000参考取值来源: DescribeDisks |
SystemDisk.BurstingEnabledboolean | 是否开启 Burst(性能突发)。取值范围:展开详情 示例值:true |
IoOptimizedstring | 是否为 I/O 优化实例。取值范围:展开详情 示例值:optimized |
InstanceChargeTypestring | 实例的计费方式。取值范围:展开详情 示例值:PrePaid参考取值来源: DescribeInstances |
Periodinteger<int32> | 购买资源的时长,单位为:月。当创建实例时,参数 示例值:1 |
InternetChargeTypestring | 网络计费方式。取值范围:展开详情 示例值:PayByTraffic |
EnableVmOsConfigboolean | 是否启用实例操作系统配置。展开详情 示例值:false |
NetworkTypestring | 实例网络类型。取值范围:展开详情 示例值:vpc |
UserDatastring | 实例自定义数据,需要以 Base64 方式编码,原始数据最多为 32 KB。 示例值:ZWNobyBoZWxsbyBlY3Mh参考取值来源: DescribeUserData |
KeyPairNamestring | 密钥对名称。展开详情 示例值:testKeyPairName参考取值来源: DetachKeyPair CreateKeyPair ImportKeyPair AttachKeyPair DescribeKeyPairs |
RamRoleNamestring | 实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。 示例值:testRamRoleName参考取值来源: DetachInstanceRamRole AttachInstanceRamRole DescribeInstanceRamRole |
AutoReleaseTimestring | |
SpotStrategystring | 按量实例的抢占策略。当参数 示例值:NoSpot |
SpotPriceLimitnumber<float> | 设置实例的每小时最高价格。支持最大 3 位小数,参数 示例值:0.97取值 <= 999999 |
SpotDurationinteger<int32> | 抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:展开详情 示例值:1 |
ResourceGroupIdstring | 实例、块存储和弹性网卡所在的企业资源组 ID。 示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSnapshotGroups |
TemplateResourceGroupIdstring | 启动模板所在的企业资源组 ID。 示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeLaunchTemplates |
SecurityEnhancementStrategystring | 是否为操作系统开启安全加固。取值范围:展开详情 示例值:Deactive |
PrivateIpAddressstring | 实例私网 IP 地址。展开详情 示例值:10.1.**.**参考取值来源: AssignPrivateIpAddresses |
DeploymentSetIdstring | 部署集 ID。 示例值:ds-bp1brhwhoqinyjd6****参考取值来源: CreateDeploymentSet DescribeDeploymentSets |
Ipv6AddressCountinteger<int32> | 为主网卡指定随机生成的 IPv6 地址数量。取值范围为 1~10。 示例值:1 |
DataDiskarray<object> | 数据盘信息列表。 子级条数 <= 16 |
NetworkInterfacearray<object> | 弹性网卡信息。 子级条数 <= 8 |
Tagarray<object> | 通过该模板的版本创建的实例、云盘和主网卡的标签信息。展开详情 子级条数 <= 20 |
SecurityGroupIdsarray<string> | |
SystemDisk.Encryptedstring | 系统盘是否加密。取值范围:展开详情 示例值:false参考取值来源: DescribeDiskEncryptionByDefaultStatus |
DeletionProtectionboolean | 实例释放保护属性,指定是否支持通过控制台或 API( DeleteInstance )释放实例。取值范围:展开详情 示例值:false |
CreditSpecificationstring | 设置突发性能实例的运行模式。取值范围:展开详情 示例值:Standard |
AutoRenewboolean | 是否要自动续费。取值范围:展开详情 示例值:true |
AutoRenewPeriodinteger<int32> | 单次自动续费的续费时长。取值范围: 展开详情 示例值:1 |
PeriodUnitstring | 包年包月计费方式的时长单位。取值范围: 展开详情 示例值:Month |
HttpEndpointstring | 是否启用实例元数据的访问通道。取值范围:展开详情 示例值:enabled |
HttpTokensstring | 访问实例元数据时是否强制使用加固模式(IMDSv2)。取值范围:展开详情 示例值:optional |
HttpPutResponseHopLimitinteger<int32> | 说明
该参数暂未开放使用。
示例值:3 |
返回参数
字段名称 | 字段详情 |
---|---|
LaunchTemplateIdstring | 实例启动模板 ID。 示例值:lt-m5eiaupmvm2op9d**** |
RequestIdstring | 请求 ID。 示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
LaunchTemplateVersionNumberinteger<int64> | 实例启动模板版本号。 注意
请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。 示例值:20 |