云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考启动模版CreateLaunchTemplate - 创建实例启动模板
复制全文
下载 pdfCreateLaunchTemplate - 创建实例启动模板
文档反馈
问问助手使用说明
创建实例启动模版时，不会限制或校验实例相关参数。仅当使用该模版创建实例时校验相关参数，如果校验错误，则实例创建失败。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateLaunchTemplate
要执行的操作，取值：CreateLaunchTemplate。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
LaunchTemplateTags.N.Value string[] 可选 示例值：Tags.1.Value=v1&Tags.2.Value=v2
实例启动模版的标签值。
- 参数 - N：表示标签值的序号。取值范围：1～20
- 多个标签值之间用&分隔。
命名规则如下：
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 允许为空，长度限制在0～256个字符之间。
说明
如果传入该参数，则必须传入LaunchTemplateTags.N.Key。
LaunchTemplateTags.N.Key string[] 可选 示例值：Tags.1.Key=k1&Tags.2.Key=k2
实例启动模版的标签键。
- 参数 - N：表示标签键的序号。取值范围：1～20
- 多个标签键之间用&分隔。
命名规则如下：
- 不能以volc:的任意大小写组合开头。
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 长度限制在1～128个字符之间。
说明
同一资源的标签键不允许重复。
Volumes.N.ExtraPerformanceIOPS integer[] 可选 示例值：1
云盘额外IOPS性能大小，仅ESSD FlexPL数据盘支持，单位为次/秒。 ExtraPerformanceTypeId为Balance或IOPS时需设置该参数。各个类型的额外性能取值范围如下：
- IOPS型：1～50000。
- Balance型：1～50000。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入该参数。
- 多个云盘之间用&分隔。
Volumes.N.ExtraPerformanceTypeId string[] 可选 示例值：Balance
- Balance：均衡型额外性能。
- IOPS：IOPS型额外性能。
- Throughput：吞吐量型额外性能。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入该参数。
- 多个云盘之间用&分隔。
Volumes.N.ExtraPerformanceThroughputMB integer[] 可选 示例值：1
云盘额外吞吐性能大小，单位MB/s，仅ESSD FlexPL数据盘支持。 ExtraPerformanceTypeId为Throughput时需设置该参数。 取值范围：1～650。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入该参数。
- 多个云盘之间用&分隔。
Volumes.N.SnapshotId string[] 可选 示例值：snap-31ak39j5bh8rubsn****
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入目标数据盘快照ID。
- 多个云盘之间用&分隔。
说明
- 仅极速型SSD支持通过快照创建云盘，性能型SSD不支持快照相关功能。
- 仅状态为“可用”的快照支持创建新云盘，“创建中”、“回滚中”、“删除中”及“错误”状态下的快照不支持创建新云盘。
DeploymentSetId string 可选 示例值：dps-yc1o9aahks5m57nk****
实例需要加入的部署集ID。
DeploymentSetGroupNumber integer 可选 示例值：1
当ECS实例要加入或调整的部署集策略为部署集组高可用策略（AvailabilityGroup）时，可以通过该参数指定实例在部署集中的分组号。
KeepImageCredential boolean 可选 示例值：false
是否保留镜像设置，取值：
- true：保留镜像设置，保留后将使用镜像预设的密码或密钥对登录实例。
- false（默认）：不保留镜像设置。
说明
- 仅自定义镜像、共享镜像支持该功能。
- 该参数取值为true时，请勿传入KeyPairName。
Eip.ReleaseWithInstance boolean 可选 示例值：false
公网IP是否随实例删除，仅按量计费公网IP生效。取值：
- true：公网IP随实例删除。当实例被系统自动回收（退订24小时后、到期回收等）或被调用DeleteInstance、DeleteInstances接口删除时，公网IP随实例一同释放。
- false（默认）：公网IP不随实例删除。
LaunchTemplateProjectName string 可选 示例值：default
实例启动模版所属项目，默认为default。一个资源只能归属于一个项目。
- 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
- 长度限制在64个字符以内。
ZoneId string 可选 示例值：cn-beijing-a
LaunchTemplateName string 必选 示例值：testLaunchTemplateName
实例启动模板名称。取值：
- 不能以数字、中划线、下划线开头。
- 只能包含中文、字母、数字、下划线和中划线。
- 长度限制为1 ~ 128个字符。
- 暂不支持特殊字符。
VersionDescription string 可选 示例值：testVersionDescription
实例启动模板描述。长度为1~255个英文或中文字符。
InstanceTypeId string 可选 示例值：ecs.g1.large
实例的计算规格，当前仅支持指定一个计算规格。
ImageId string 可选 示例值：image-ybmhzqo8u4l8j1ii****
ImageName string 可选 示例值：NameDemo
镜像名称。
InstanceChargeType string 可选 示例值：PostPaid
实例和云盘的计费类型，取值：
- PostPaid（默认）：按量计费。
- PrePaid：包年包月。
- Esi：弹性预约实例。
- Segmented：时段型弹性预约实例。
说明
时段型弹性预约实例功能正在邀测中，如需试用，请联系客户经理申请。
InstanceName string 可选 示例值：instance-test
实例的名称，取值：
- 不能以数字、中划线、下划线开头。
- 只能包含中文、字母、数字、下划线和中划线。
- 长度限制为1 ~ 128个字符。
- 暂不支持特殊字符，不填默认为空字符串。
Description string 可选 示例值：ECS
实例的描述，取值：
- 不能以数字、中划线开头。
- 只能包含中文、字母、数字、下划线和中划线。
- 长度限制在0 ~ 255之间。
- 不填默认为空字符串。
HostName string 可选 示例值：instance-host-name
实例的主机名，取值：
- 允许使用点号“.”分隔字符成多段。
- 每段中允许使用字母、数字或中划线“-”。
- 不能以中划线“-”或点号“.”开头或结尾，且不能连续使用中划线或点号。
- Linux系统的主机名长度限制为2～59个字符。
- Windows系统的主机名长度限制为2～10个字符，不能包含点号“.”，且不能完全是数字。
如不填，则遵循以下规则自动生成：
- 结构：iv- + 初始主机名，例如iv-3tigy72q3u3vj0******。
- 初始主机名生成逻辑：
- Linux：提取实例IDi-之后的全部字符。
- Windows：提取实例IDi-之后的后12位字符。
UniqueSuffix boolean 可选 示例值：false
表示当创建多台实例时，是否为Hostname和InstanceName自动添加有序后缀。取值范围：
- true：开启有序后缀
- false（默认）：关闭有序后缀。
说明
开启有序后缀时，若Hostname为空，系统将自动生成主机名，主机名后无有序后缀。
KeyPairName string 可选 示例值：kp-test-123
使用“SSH密钥对”登录实例时，请输入密钥对的名称。
说明
如果同时设置了KeyPairName和Password，则仅生效KeyPairName。
SecurityEnhancementStrategy string 可选 示例值：Active
是否开启安全加固，取值：
- Active：开启安全加固，仅对公共镜像生效。
- InActive：关闭安全加固，对所有镜像生效。
UserData string 可选 示例值：ZWNobyBoZWxsbyBlY3Mh
实例自定义数据。设置的自定义数据必须经过Base64编码，且Base64编码前的自定义数据大小不能超过16KB。
不填则默认为空。
HpcClusterId string 可选 示例值：hpcCluster-l8u24ovdmoab6opf****
当创建高性能计算GPU型实例时，请指定高性能计算集群ID。
Volumes.N.DeleteWithInstance boolean[] 可选 示例值：Volumes.1. DeleteWithInstance=true&Volumes.2. DeleteWithInstance=false
云盘是否随实例释放。
- 参数 - N：表示云盘的序号，取值范围：1～15。N = 1表示系统盘，系统盘默认随实例释放，不可保留；N ≥ 2表示数据盘。
- 取值 - DeleteWithInstance：云盘是否随实例释放。
- true（默认）：云盘随实例释放。取值为false时对系统盘无效，系统盘默认随实例释放，不允许保留。
- false：云盘不随实例释放。
- 多个云盘之间用&分隔。
Volumes.N.VolumeType string[] 可选 示例值：Volumes.1.VolumeType=ESSD_PL0&Volumes.2.VolumeType=ESSD_FlexPL
云盘的类型。
- 参数 - N：表示云盘的序号，取值范围：1～15。N = 1表示系统盘，N ≥ 2表示数据盘。
- 参数 - VolumeType：表示云盘的类型，取值：：
- ESSD_PL0：极速型SSD PL0
- PTSSD：性能型SSD
- 多个云盘之间用&分隔。
Volumes.N.Size integer[] 可选 示例值：Volumes.1.Size=100&Volumes.2.Size=100
云盘的容量。
- 参数 - N：表示云盘的序号，取值范围：1～15。N = 1表示系统盘；N ≥ 2表示数据盘。
- 取值 - Size：表示云盘的容量，单位为GiB。取值：
- 系统盘：
- ESSD_PL0：20～2048
- PTSSD：10～500
- 数据盘：
- ESSD_PL0：10～32768
- PTSSD：20～8192
- 多个云盘之间用&分隔。
NetworkInterfaces.N.SubnetId string[] 可选 示例值：NetworkInterfaces.1.SubnetId=subnet-3tispp1nai4e8i****& NetworkInterfaces.2.SubnetId=subnet-2ff1nczrx2lts5oxru****
实例的私有网络子网ID，创建实例时，支持同时绑定辅助网卡：
- 参数 - N：表示网卡的序号，序号为“1”表示主网卡；序号为“2”或大于“2”表示辅助网卡。
- 取值 - SubnetId：表示第N个网卡的子网ID。
- 多个私有网络子网ID之间用&分隔。
NetworkInterfaces.N.SecurityGroupIds.N string[] 可选 示例值：NetworkInterfaces.1.SecurityGroupIds.1=sg-3ti78x9h8t4bw*****& NetworkInterfaces.2.SecurityGroupIds.1=sg-3cj59ih2v9hj46c6rr******
网卡关联的安全组ID：
- 参数 - N：表示网卡的序号，序号为“1”表示主网卡；序号为“2”或大于“2”表示辅助网卡。
- 参数 - N：表示第N个网卡关联的安全组的序号，最多支持同时绑定5个安全组，取值：1 - 5。
- 取值 - SecurityGroupIds：表示第N个网卡关联的第N个安全组的ID。
- 多个安全组ID之间用&分隔。
VpcId string 可选 示例值：vpc-3thbinq64t4bwbha****
Eip.Bandwidth integer 可选 示例值：1
公网IP的带宽上限，单位：Mbps。
- 取值范围：1～500。
- 默认值：1。
说明
配置Eip.Bandwidth或Eip.ISP后，伸缩组创建实例时即会分配公网IP，默认按照按量计费-按固定带宽计费。
Eip.ISP string 可选 示例值：BGP
公网IP的线路类型，取值：
- BGP：BGP（多线）。
- 若您的账号已申请并开通了静态单线权限，则可传入如下取值：
- ChinaMobile：中国移动静态单线。
- ChinaTelecom：中国电信静态单线。
- ChinaUnicom：中国联通静态单线。
说明
配置Eip.Bandwidth或Eip.ISP后，伸缩组创建实例时即会分配公网IP，默认按照按量计费-按固定带宽计费。
Eip.BandwidthPackageId string 可选 示例值：bwp-2zeo05qre24nhrqpy****
- 二者的安全防护类型相同。
- 二者的线路类型相同。
- 共享带宽包为IPv4类型。
Eip.SecurityProtectionTypes.N string[] 可选 示例值：AntiDDoS_Enhanced
公网IP的安全防护类型。
- 参数 - N：表示安全防护类型的序号，当前仅支持取1。
- 取值：
- AntiDDoS_Enhanced：申请增强防护类型的公网IP，可加入到DDoS原生防护（企业版）实例。
说明
- 若传入AntiDDoS_Enhanced，则EipAddress.ChargeType不能为PrePaid，且EipAddress.ISP必须传入BGP。
- 增强防护类型公网IP正在邀测中，如需试用，请提交工单或联系客户经理申请。
Eip.SecurityProtectionInstanceId integer 可选 示例值：151
DDoS原生防护（企业版）ID。
- 您可以调用DescInstanceList接口，查询DDoS原生防护（企业版）的ID。
- 当SecurityProtectionTypes.N传入AntiDDoS_Enhanced时，此参数必须传入。
Tags.N.Key string[] 可选 示例值：Tags.1.Key=k1&Tags.2.Key=k2
实例的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～20。
- 多个标签键之间用&分隔。
命名规则如下：
- 不能以volc:的任意大小写组合开头。
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 长度限制在1～128个字符之间。
说明
同一资源的标签键不允许重复。
Tags.N.Value string[] 可选 示例值：Tags.1.Value=v1&Tags.2.Value=v2
实例的标签值。
- 参数 - N：表示标签值的序号，取值范围：1～20。
- 多个标签值之间用&分隔。
命名规则如下：
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 允许为空，长度限制在0～256个字符之间。
说明
如果传入该参数，则必须先传入Tags.N.Key。
SpotStrategy string 可选 示例值：NoSpot
按量计费实例的抢占式策略，取值：
- NoSpot（默认）：表示创建正常按量计费实例。
- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。
- SpotWithPriceLimit：设置出价上限的抢占式实例。
SpotPriceLimit float 可选 示例值：0.78
抢占式实例的每小时最高价格，支持最大3位小数。
说明
仅当SpotStrategy=SpotWithPriceLimit时，该参数生效。
ProjectName string 可选 示例值：default
实例所属项目。
- 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
- 长度限制在64个字符以内。
ScheduledInstance.ScheduledInstanceName string 可选 示例值：ESI-Name
弹性预约单的名称，取值：
- 不能以数字、中划线、下划线开头。
- 只能包含中文、字母、数字、下划线和中划线。
- 长度限制为1～128个字符。
- 暂不支持特殊字符，不填默认为空字符串。
ScheduledInstance.ScheduledInstanceDescription string 可选 示例值：用于测试的弹性预约单
弹性预约单的描述。
- 必须以字母或中文开头。
- 只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。”
- 长度限制在255个字符以内。
- 不填默认为空字符串。
Eip.BillingType integer 可选 示例值：2
公网IP的计费方式，取值：
- 2：按量计费-按带宽上限计费。
- 3：按量计费-按实际流量计费。
SuffixIndex integer 可选 示例值：1
有序后缀的起始序号。
- 取值范围：1～999。
- 默认值：1。
返回参数
LaunchTemplateId string 示例值：lt-ysxc16auaugh9zfy****
实例启动模板 ID。
请求示例
GET /?Action=CreateLaunchTemplate&Version=2020-04-01&LaunchTemplateName=test&ZoneId=cn-beijing-a HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
Region: cn-beijing
ServiceName: ecs
返回示例
{
"ResponseMetadata": {
"RequestId": "20220419160338010225133143077B****",
"Action": "CreateLaunchTemplate",
"Version": "2020-04-01",
"Service": "ecs",
"Region": "cn-beijing"
},
"Result": {
"LaunchTemplateId": "lt-ysxc16auaugh9zfy****"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidArgument | The specified argument is invalid. | 指定的参数不合法。 |
最近更新时间：2026.01.09 16:40:43
这个页面对您有帮助吗？
有用
有用
无用
无用