Creates a version based on the specified instance launch template.

Description

You can create up to 30 versions of each instance launch template. Instead of a template modification API, we provide a version iteration API (CreateLaunchTemplateVersion) that allows you to modify the parameters in a template by creating a new version. For more information, see CreateLaunchTemplate.

Request parameters

Name Type Required Description
Action String Yes The name of this interface. Value: CreateLaunchTemplateVersion.
RegionId String Yes Region ID of an instance. You can call DescribeRegions to obtain the latest region list.
LaunchTemplateId String Yes Instance launch template ID. For more information, call DescribeLaunchTemplates. Either the LaunchTemplateId or the LaunchTemplateName must be specified to choose a template.
LaunchTemplateName String Yes Instance launch template name.
VersionDescription String No Description of instance launch template version. It can be [2, 256] characters in length. It cannot begin with http:// or https://. The default value is null.
ImageId String No Image ID.
InstanceType String No Instance type. For more information, call DescribeInstanceTypes to obtain the latest instance type list.
SecurityGroupId String No The security group ID.
NetworkType String No Network type of the instance. Optional values: Classic | VPC.
VSwitchId String No When creating a VPC-Connected instance, you must specify its VSwitch ID.
InstanceName String No The name of the instance. The instance name is a string of 2 to 128 English letters and special characters. It must start with a letter. It can contain numbers, periods (.), colons (:), underscores (_), and hyphens (-). It cannot start with "http://" or "https://".
Description String No Instance description.
InternetMaxBandwidthIn String No The maximum inbound bandwidth from the internet network, measured in Mbit/s. Value range: [1, 200]. 
InternetMaxBandwidthOut String No The maximum outbound bandwidth to the internet network, measured in Mbit/s. Value range: [0, 100].
HostName String No Instance host name.
  • "HostName" cannot start or end with a period (.) or hyphen (-), or contain consecutive periods (.) or hyphens (-).
  • Windows instances: The HostName is the string of 2 to 15 characters that can contain English letters, numbers, and hyphens (-). It must not contain periods (.) or only numbers.
  • In other operating systems, such as Linux, the HostName can be a string of 2 to 128 characters, which can be separated into segments by periods (.). Each segment can contain uppercase or lowercase letters, numbers, and hyphens (-).
ZoneId String No The zone ID of the instance.
SystemDisk.Category String No The category of the system disk. Optional values:
  • cloud: Basic cloud disk.
  • cloud_efficiency: Ultra cloud disk.
  • cloud_ssd: SSD cloud disk.
  • ephemeral_ssd: Ephemeral SSD.
SystemDisk.Size Integer No The system disk size, in GiB. Value range: [20, 500].
SystemDisk.DiskName String No System Disk name. It is a string of 2 to 128 English letters and special characters. It must start with an English letter. It can contain numbers, colons (:), periods (.), underscores (_), and hyphens (-). It cannot start with "http://" or "https://".
SystemDisk.Description String No System Disk description. Length: [2, 256] characters. It cannot start with "http://" or "https://".
DataDisk.n.Category String No The data disk type. Value range of n: [1, 16]. Optional values:
  • cloud: Basic cloud disk.
  • cloud_efficiency: Ultra cloud disk.
  • cloud_ssd: SSD cloud disk.
  • ephemeral_ssd: Ephemeral SSD.
DataDisk.n.Size Integer No The data disk capacity. Value range of n: [1, 16]. Value range:
  • cloud: [5, 2000]
  • cloud_efficiency: [20, 32768]
  • cloud_ssd: [20, 32768]
  • ephemeral_ssd: [5, 800]
DataDisk.n.SnapshotId String No The snapshot used to create the data disk. Value range of n: [1, 16].
DataDisk.n.Encrypted Boolean No Whether the data disk is encrypted. Value range of n: [1, 16].
DataDisk.n.DiskName String No The data disk name. Value range of n: [1, 16].
DataDisk.n.Description String No The data disk description. Value range of n: [1, 16].
DataDisk.n.DeleteWithInstance String No Whether the data disk is released with its instance. Value range of n: [1, 16].
IoOptimized String No Whether it is an I/O-optimized instance or not. Optional values:
  • none
  • optimized
NetworkInterface.n.PrimaryIpAddress String No The primary private IP address of ENI number n. For the value range of n , see Instance type families.
NetworkInterface.n.VSwitchId String No The VSwitch ID for number n ENI. The instance must be in the same zone of the same VPC network as the ENI, but they may belong to different VSwitches. For the value range of n , see Instance type families.
NetworkInterface.n.SecurityGroupId String No The security group ID for n must specify a security group in the same VPC network. For the value range of n , see Instance type families.
NetworkInterface.n.NetworkInterfaceName String No The name of ENI number n. For the value range of n, see Instance type families.
NetworkInterface.n.Description String No The description of ENI number n. For the value range of n , see Instance type families.
InternetChargeType String No Internet bandwidth billing method. Value options: PayByTraffic
UserData String No User data of the instance, which is Base64-encoded. Size of the raw data cannot exceed 16 KB.
KeyPairName String No The name of the key pair.
  • This parameter is valid only for a Linux instance. It is null by default. If a value is set for parameter KeyPairName, the Password still takes effect.
  • The user name and password authentication method is disabled if a value is set for parameter KeyPairName for a Linux instance.
RamRoleName String No The RAM role name of the instance. You can use the RAM API ListRoles to query instance RAM role names.
AutoReleaseTime String No Instance auto release time. The time is presented using the ISO8601 standard and in UTC time. The format is YYYY-MM-DDTHH:MM:SSZ.
SpotStrategy String No The preemption strategy for Pay-As-You-Go (PostPaid) instances. This parameter is valid and mandatory only when InstanceChargeType is set to PostPaid. Optional values:
  • NoSpot: Normal Pay-As-You-Go instance.
  • SpotWithPriceLimit: Sets the maximum price for a spot instance.
  • SpotAsPriceGo: The system automatically calculates the price. The maximum value is the Pay-As-You-Go price.
SpotPriceLimit Float No Sets the maximum hourly instance price. Supports up to three decimal places.
SecurityEnhancementStrategy String No Whether or not to activate the security enhancement feature and install network security software free of charge. Optional values: Active | Deactive.
Tag.n.Key String No The instance tag key. The valid range of n is [1, 5]. Supports up to 64 characters. Cannot begin with "aliyun", "acs:", "http://", or "https://".
Tag.n.Value Float  No The instance tag value. The valid range of n is [1, 5]. Supports up to 128 characters. Cannot begin with "aliyun", "http://", or "https://".

Response parameters

Name Type Description
LaunchTemplateVersionNumber Long The launch instance template version number.

Examples

Request example 
https://ecs.aliyuncs.com/?Action=CreateLaunchTemplateVersion
&RegionId=cn-hangzhou
&LaunchTemplateName=lt-name1
&InstanceType=ecs.cm4.6xlarge
&SecurityGroupId=sg-securitygroupid
&<Common Request Parameters>
Response example

XML format

<CreateLaunchTemplateVersionResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FExxxxx</RequestId>
    <LaunchTemplateVersionNumber>2</LaunchTemplateVersionNumber>
</CreateLaunchTemplateVersionResponse>
JSON format 
{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FExxxxx",
    "LaunchTemplateVersionNumber": 2
}

Error codes

The following error codes are specific to this interface. For more error codes, visit the API error center.

Error code Error messages HTTP status code  Description
InvalidLaunchTemplate.NotFound The specified LaunchTemplateId “{0}” LaunchTemplateName “{1}” is not found. 400 The specified LaunchTemplateId or LaunchTemplateName is not found.
MissingParameter The input parameter “{0}” that is mandatory for processing this request is not supplied. 400 A required parameter is missing.
InvalidParameter the parameter(s) “{0}” provided is(are) invalid. 400 The specified parameter is invalid.
InvalidDescription.Malformed The specified parameter “VersionDescription” is not valid. 400 The specified VersionDescription is invalid.
InvalidUserData.SizeExceeded The specified parameter UserData exceeds the size. 400 The raw UserData exceeds 16 KB.
InvalidUserData.Base64FormatInvalid The specified parameter UserData must be base64 encoded. 400 UserData must be Base64-encoded.
LaunchTemplateVersionLimitExceed The maximum number of template’s versions is exceeded. 403 You can create up to 30 versions of each instance launch template.
InnerServiceFailed call inner service failed 403 An internal server error.