You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /云服务器/云服务器ECS/API参考/实例启动模版/CreateLaunchTemplate - 创建实例启动模板
CreateLaunchTemplate - 创建实例启动模板
最近更新时间：2024.12.02 17:35:29首次发布时间：2024.08.15 14:19:16
我的收藏

调用 CreateLaunchTemplate 接口，创建一个实例启动模板。操作说明和注意事项请参见创建实例启动模板。

说明

创建实例启动模版时，不会限制或校验实例相关参数。仅当使用该模版创建实例时校验相关参数，如果校验错误，则实例创建失败。

请求参数

名称类型是否必填示例值描述
ActionString是CreateLaunchTemplate要执行的操作，取值：CreateLaunchTemplate。
VersionString是2020-04-01API的版本，取值：2020-04-01。

ZoneId

String

否

cn-beijing-a

实例所属的可用区ID，您可以调用 DescribeZones 接口查询一个地域下的可用区信息。

LaunchTemplateName

String

是

testLaunchTemplateName

实例启动模板名称，取值：

  • 不能以数字、中划线、下划线开头。

  • 只能包含中文、字母、数字、下划线“_”和中划线“-”。

  • 长度限制为1～128个字符。

  • 暂不支持特殊字符。

VersionDescriptionString否testVersionDescription实例启动模板描述。长度为1～256个英文或中文字符。

InstanceTypeId

String

否

ecs.g3i.large

实例的计算规格，当前仅支持指定一个计算规格。
实例规格的更多信息，请参见实例规格介绍；也可以调用 DescribeInstanceTypes 接口获取最新的规格列表。

ImageIdString否image-ybmhzqo8u4l8j1ii****启动实例时使用的镜像ID，您可以通过 DescribeImages 接口查询可以使用的镜像资源。
ImageNameString否NameDemo镜像名称。

InstanceChargeType

String

否

PostPaid

实例和云盘的计费类型，取值：

  • PostPaid（默认）：按量计费。

  • PrePaid：包年包月。

  • Esi：弹性预约实例。

  • Segmented：弹性预约实例-时段型。

说明

弹性预约实例功能正在邀测中，如需试用，请联系客户经理申请。

InstanceName

String

否

instance-1

实例的名称，取值：

  • 不能以数字、中划线“-”、下划线“_”开头。

  • 只能包含中文、字母、数字、下划线“_”、中划线“-”。

  • 长度限制为1～128个字符。

  • 暂不支持特殊字符，不填默认为空字符串。

Description

String

否

云服务器实例

实例的描述，取值：

  • 不能以数字、中划线“-”开头。

  • 只能包含中文、字母、数字、下划线“_”和中划线“-”。

  • 长度限制在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为空，系统将自动生成主机名，主机名后无有序后缀。

SuffixIndex

Integer

否

1

有序后缀的起始序号。

  • 取值范围：1～999。

  • 默认值：1。

KeyPairName

String

否

kp-test-123

使用“SSH密钥对”登录实例时，请输入密钥对的名称。

说明

如果同时设置了KeyPairName和Password，则仅生效KeyPairName。

SecurityEnhancementStrategy

String

否

Active

是否开启安全加固，取值：

  • Active：开启安全加固，仅对公共镜像生效。

  • InActive：关闭安全加固，对所有镜像生效。

UserData

String

否

ZWNobyBoZWxsbyBlY3Mh

实例自定义数据。设置的自定义数据必须经过Base64编码，且Base64编码前的自定义数据大小不能超过16KB。
不填则默认为空。

HpcClusterIdString否hpcCluster-l8u24ovdmoab6opf****当创建高性能计算GPU型实例时，请指定高性能计算集群ID。

Volumes.N.VolumeType

String

否

Volumes.1.VolumeType=ESSD_PL0&Volumes.2.VolumeType=ESSD_PL0

云盘的类型。

  • 参数 - 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

  • 多个云盘之间用&分隔。

Volumes.N.DeleteWithInstance

Boolean

否

Volumes.1.
DeleteWithInstance=true&Volumes.2.
DeleteWithInstance=false

云盘是否随实例释放。

  • 参数 - N：表示云盘的序号，取值范围：1～15。N = 1表示系统盘，系统盘默认随实例释放，不可保留；N ≥ 2表示数据盘。

  • 取值 - DeleteWithInstance：云盘是否随实例释放。

    • true（默认）：云盘随实例释放。取值为false时对系统盘无效，系统盘默认随实例释放，不允许保留。

    • false：云盘不随实例释放。

  • 多个云盘之间用&分隔。

NetworkInterfaces.N.SubnetId

String

否

NetworkInterfaces.1.SubnetId=subnet-3tispp1nai4e8i****& NetworkInterfaces.2.SubnetId=subnet-2ff1nczrx2lts5oxru****

实例的私有网络子网ID，创建实例时，支持同时绑定辅助网卡。

  • 参数 - N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。

  • 取值 - SubnetId：表示网卡的子网ID。

  • 多个私有网络子网ID之间用&分隔。

NetworkInterfaces.N.SecurityGroupIds.N

String

否

NetworkInterfaces.1.SecurityGroupIds.1=sg-3ti78x9h8t4bw*****& NetworkInterfaces.2.SecurityGroupIds.1=sg-3cj59ih2v9hj46c6rr******

网卡关联的安全组ID：

  • 第一个N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。

  • 第二个N：表示网卡关联的安全组的序号，取值范围：1～5。

  • 取值 - SecurityGroupIds：表示安全组的ID。

  • 多个安全组ID之间用&分隔。

VpcId

String

否

vpc-3thbinq64t4bwbha****

私有网络ID，您可以调用 DescribeVpcs 接口查询满足条件的私有网络。

Eip.BillingType

Integer

否

2

公网IP的计费方式，取值：

  • 2：按量计费-按带宽上限计费。

  • 3：按量计费-按实际流量计费。

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****

共享带宽包的ID，表示将公网IP加入到共享带宽包。 您可以调用 DescribeBandwidthPackages 接口，查询共享带宽包的ID。 公网IP加入到共享带宽包必须同时满足如下条件：

  • 二者的安全防护类型相同。

  • 二者的线路类型相同。

  • 共享带宽包为IPv4类型。

Eip.SecurityProtectionTypes.N

String

否

AntiDDoS_Enhanced

公网IP的安全防护类型。

  • 参数 - N：表示安全防护类型的序号，当前仅支持取1。

  • 取值：

    • AntiDDoS_Enhanced：申请增强防护类型的公网IP，可加入到DDoS原生防护（企业版）实例。

说明

  • 若传入AntiDDoS_Enhanced，则EipAddress.ChargeType不能为PrePaid，且EipAddress.ISP必须传入BGP。

  • 增强防护类型公网IP正在邀测中，如需试用，请提交工单或联系客户经理申请。

  • 不填则表示基础防护类型的公网IP。

Eip.SecurityProtectionInstanceId

Integer

否

151

DDoS原生防护（企业版）ID。

  • 您可以调用DescInstanceList接口，查询DDoS原生防护（企业版）的ID。

  • 当SecurityProtectionTypes.N传入AntiDDoS_Enhanced时，此参数必须传入。

SpotStrategy

String

否

NoSpot

按量计费实例的抢占式策略，取值：

  • NoSpot（默认）：表示创建正常按量计费实例。

  • SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。

  • SpotWithPriceLimit：设置出价上限的抢占式实例。

说明

  • 当InstanceChargeType取值为PostPaid时，该参数生效。

  • 抢占式实例的出价模式请参见购买抢占式实例。

SpotPriceLimit

Float32

否

0.78

抢占式实例的每小时最高价格，支持最大3位小数。

说明

仅当SpotStrategy=SpotWithPriceLimit时，该参数生效。

ProjectName

String

否

default

实例所属项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。

  • 长度限制在64个字符以内。

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。

LaunchTemplateProjectName

String

否

default

实例启动模版所属项目，默认为default。一个资源只能归属于一个项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。

  • 长度限制在64个字符以内。

ScheduledInstance.ScheduledInstanceName

String

否

ESI-Name

弹性预约单的名称，取值：

  • 不能以数字、中划线、下划线开头。

  • 只能包含中文、字母、数字、下划线和中划线。

  • 长度限制为1～128个字符。

  • 暂不支持特殊字符，不填默认为空字符串。

ScheduledInstance.ScheduledInstanceDescription

String

否

用于测试的弹性预约单

弹性预约单的描述。

  • 必须以字母或中文开头。

  • 只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。”

  • 长度限制在255个字符以内。

  • 不填默认为空字符串。

返回数据

名称类型示例值描述
LaunchTemplateIdStringlt-ysxc16auaugh9zfy****实例启动模板ID。

请求示例

GET /?Action=CreateLaunchTemplate&Version=2020-04-01&LaunchTemplateName=testLaunchTemplateName&ZoneId=cn-beijing-a HTTP/1.1
Host: open.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****"
    }
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.AccountIdThe required parameter AccountId is not supplied.账户ID不能为空。
400MissingParameter.LaunchTemplateNameAndLaunchTemplateIdThe required parameter LaunchTemplateName and LaunchTemplateId is not supplied.模版名称和模版ID不允许同时为空。
400InvalidTemplateVersionDescription.MalformedThe specified TemplateVersionDescription is malformed.指定的模板版本描述不合法。

400

LimitExceeded.TemplateVersionDescription

You've reached the limit on the length of TemplateVersionDescription.

版本描述长度超过限制。

409InvalidTemplateName.ConflictThe specified TemplateName already existed.实例启动模板名称不能重复。
400MissingParameter.TemplateNameThe required parameter TemplateName is not supplied.实例启动模板名称不能为空。
400LimitExceeded.LaunchTemplateNameYou've reached the limit on the length of LaunchTemplateName.模板名称长度超过限制。
400InvalidLaunchTemplateName.MalformedThe specified LaunchTemplateName is malformed.指定的模板名称不合法。
400InvalidInstanceName.MalformedThe specified InstanceName is malformed.指定的实例名称不合法。
400LimitExceeded.InstanceNameYou've reached the limit on the length of InstanceName.实例名称长度超过限制。
400InvalidHostName.MalformedThe specified HostName is malformed.指定的主机名不合法。
400InvalidInstanceDescription.MalformedThe specified InstanceDescription is malformed.指定的实例描述不合法。
400LimitExceeded.InstanceDescriptionYou've reached the limit on the length of InstanceDescription.实例描述长度超过限制。
400InvalidSpotPriceLimit.MalformedThe specified SpotPriceLimit is malformed.指定的实例抢占价格不合法。
400InvalidSecurityProtectionType.MalformedThe specified SecurityProtectionType is malformed.指定的安全防护类型不合法。
400InvalidScheduledInstanceName.MalformedThe specified ScheduledInstanceName is malformed.指定的弹性预约单名称不合法。

400

LimitExceeded.ScheduledInstanceName

You've reached the limit on the length of ScheduledInstanceName.

弹性预约单名称长度超过限制。

400InvalidScheduledInstanceDescription.MalformedThe specified ScheduledInstanceDescription is malformed.指定的弹性预约单描述不合法。
400LimitExceeded.ScheduledInstanceDescriptionYou've reached the limit on the length of ScheduledInstanceDescription.弹性预约单描述长度超过限制。
400QuotaExceeded.TemplateQuotaYou've reached the limit on the Quota.该账号下实例启动模板数量超限额。
400InvalidSuffixIndex.MalformedThe specified SuffixIndex is malformed.指定的有序后缀不合法。

500

InternalError

An internal error has occurred.

内部错误，请重试。如果多次尝试失败，请提交工单。