Creates a launch template. A launch template eliminates the need to configure a large number of parameters every time you create an Elastic Compute Service (ECS) instance.
Operation description
Description
Launch templates contain preset configurations used to create instances, such as the region, image ID, instance type, security group ID, and public bandwidth settings. If a specific parameter is not included in a launch template, you must manually specify the parameter when you use the launch template to create an instance.
After you create a launch template (CreateLaunchTemplate
), its version number is set to 1 by default. You can create multiple versions (CreateLaunchTemplateVersion
) for the launch template. Version numbers start from 1 and increment by one. If you do not specify a template version number when you use a launch template to create instances ( RunInstances ), the default version is used.
When you call this operation, take note of the following items:
- You can create up to 30 launch templates in each region. Each launch template can have up to 30 versions.
- Most parameters in launch templates are optional. When you create a launch template, ECS does not verify the existence or validity of specified parameter values. The validity of the parameter values are verified only when you use the launch template to create instances.
- If you set a specific parameter in a launch template, you cannot filter out this parameter when you use the launch template to create instances ( RunInstances ). For example, if you set the
HostName
parameter to LocalHost in a launch template and do not set theHostName
parameter when you call theRunInstances
operation to create instances from the launch template, the created instance still has a hostname ofLocalHost
. If you want to overwrite theLocalHost
value of HostName provided by the launch template, you can setHostName
to MyHost or another value when you call theRunInstances
operation.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region in which to create the launch template. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
TemplateTag | object [] | No | The tags to add to the launch template. | |
Key | string | No | The key of tag N to add to the launch template. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with | TestKey |
Value | string | No | The value of tag N to add to the launch template. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length and cannot start with | TestValue |
LaunchTemplateName | string | Yes | The name of the launch template. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with | testLaunchTemplateName |
VersionDescription | string | No | The description of the launch template version. The description must be 2 to 256 characters in length and cannot start with | testVersionDescription |
ImageId | string | No | The ID of the image to use to create the instance. You can call the DescribeImages operation to query available images. | win2008r2_64_ent_sp1_en-us_40G_alibase_20170915.vhd |
ImageOwnerAlias | string | No | The source of the image. Valid values:
| system |
PasswordInherit | boolean | No | Specifies whether to use the preset password of the image. Note
If you set the PasswordInherit parameter to true, make sure that you leave the Password parameter empty and the selected image has a preset password.
| false |
InstanceType | string | No | The instance type of the instance. For more information, see Instance families. Alternatively, you can call the DescribeInstanceTypes operation to query the most recent instance type list. | ecs.g5.large |
SecurityGroupId | string | No | The ID of the security group to which to assign the instance. Instances in the same security group can communicate with each other. A security group can contain up to 1,000 instances. Note
You cannot specify both the SecurityGroupId and SecurityGroupIds.N parameters.
| sg-bp15ed6xe1yxeycg**** |
VpcId | string | No | The ID of the virtual private cloud (VPC). | vpc-bp12433upq1y5scen**** |
VSwitchId | string | No | The ID of the vSwitch to which to connect the instance. This parameter is required if you specify the VpcId parameter. | vsw-bp1s5fnvk4gn2tws0**** |
InstanceName | string | No | The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with | testInstanceName |
Description | string | No | The instance description. The description must be 2 to 256 characters in length and cannot start with | testECSDescription |
InternetMaxBandwidthIn | integer | No | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:
| 10 |
InternetMaxBandwidthOut | integer | No | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. | 10 |
HostName | string | No | The instance hostname.
| testHostName |
ZoneId | string | No | The ID of the zone in which to create the instance. | cn-hangzhou-g |
SystemDisk.Category | string | No | The category of the system disk. Valid values:
For non-I/O optimized instances of a retired instance type, the default value is cloud. For other types of instances, the default value is cloud_efficiency. | cloud_ssd |
SystemDisk.Size | integer | No | The size of the system disk. Unit: GiB. Valid values: 20 to 500. The value of this parameter must be at least 20 and greater than or equal to the size of the specified image. | 40 |
SystemDisk.DiskName | string | No | The name of the system disk. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with | testSystemDiskName |
SystemDisk.Description | string | No | The description of the system disk. The description must be 2 to 256 characters in length and cannot start with | testSystemDiskDescription |
SystemDisk.Iops | integer | No | Note
This parameter is in invitational preview and is unavailable for general users.
| null |
SystemDisk.PerformanceLevel | string | No | The performance level of the ESSD to use as the system disk. Default value: PL0. Valid values:
For more information about ESSD performance levels, see ESSDs . | PL0 |
SystemDisk.DeleteWithInstance | boolean | No | Specifies whether to release the system disk when the instance is released. Valid values:
Default value: true. | true |
SystemDisk.AutoSnapshotPolicyId | string | No | The ID of the automatic snapshot policy to apply to the system disk. | sp-gc7c37d4ylw7mtnk**** |
SystemDisk.ProvisionedIops | long | No | The provisioned read/write IOPS of the ESSD AutoPL disk to use as the system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS} Baseline IOPS = min{1,800 + 50 × Capacity, 50,000} Note
This parameter is available only if you set the SystemDisk.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.
| 50000 |
SystemDisk.BurstingEnabled | boolean | No | Specifies whether to enable the performance burst feature for the system disk. Valid values:
| true |
IoOptimized | string | No | Specifies whether to create an I/O optimized instance. Valid values:
| optimized |
InstanceChargeType | string | No | The billing method of the instance. Valid values:
| PrePaid |
Period | integer | No | The subscription duration of the instance. Unit: months. This parameter is valid and required only when | 1 |
InternetChargeType | string | No | The billing method for network usage. Valid values:
Note
When the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidths may be limited. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage.
| PayByTraffic |
EnableVmOsConfig | boolean | No | Specifies whether to enable the operating system configuration of the instance. Note
This parameter will be removed in the future. To ensure future compatibility, we recommend that you use other parameters.
| false |
NetworkType | string | No | The network type of the instance. Valid values:
| vpc |
UserData | string | No | The user data of the instance. The user data must be encoded in Base64. The maximum size of raw data is 16 KB. | ZWNobyBoZWxsbyBlY3Mh |
KeyPairName | string | No | The name of the key pair. This parameter is empty by default.
| testKeyPairName |
RamRoleName | string | No | The name of the instance Resource Access Management (RAM) role. You can call the ListRoles operation provided by RAM to query the instance RAM roles that you created. | testRamRoleName |
AutoReleaseTime | string | No | The automatic release time of the instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
| 2018-01-01T12:05:00Z |
SpotStrategy | string | No | The bidding policy for the pay-as-you-go instance. This parameter is valid only when the
| NoSpot |
SpotPriceLimit | float | No | The maximum hourly price of the instance. The value is accurate to three decimal places. This parameter is valid only when the | 0.97 |
SpotDuration | integer | No | The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values:
Alibaba Cloud sends ECS system events to notify you 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify a protection period based on your business requirements. Note
If you set SpotStrategy to SpotWithPriceLimit or SpotAsPriceGo, this parameter takes effect.
| 1 |
ResourceGroupId | string | No | The ID of the resource group to which to assign the instance, Elastic Block Storage (EBS) device, and elastic network interface (ENI). | rg-bp67acfmxazb4p**** |
TemplateResourceGroupId | string | No | The ID of the resource group to which the launch template belongs. | rg-bp67acfmxazb4p**** |
SecurityEnhancementStrategy | string | No | Specifies whether to enable security hardening for the operating system. Valid values:
| Deactive |
PrivateIpAddress | string | No | The private IP address to assign to the instance. To assign a private IP address to an instance that resides in a VPC, make sure that the IP address is an idle IP address within the CIDR block of the vSwitch specified by the | 10.1.**.** |
DeploymentSetId | string | No | The ID of the deployment set to which to deploy the instance. | ds-bp1brhwhoqinyjd6**** |
Ipv6AddressCount | integer | No | The number of IPv6 addresses to randomly generate for the primary elastic network interface (ENI). Valid values: 1 to 10. | 1 |
DataDisk | object [] | No | The data disks. | |
PerformanceLevel | string | No | The performance level of the ESSD to use as data disk N. The value of N must be the same as that in
For more information about ESSD performance levels, see ESSDs . | PL1 |
Description | string | No | The description of data disk N. The description must be 2 to 256 characters in length and cannot start with | testDataDiskDescription |
SnapshotId | string | No | The ID of the snapshot to use to create data disk N. Valid values of N: 1 to 16. When the Use snapshots that were created on or after July 15, 2013. Otherwise, an error is returned and your request is rejected. | s-bp17441ohwka0yuh**** |
Size | integer | No | The size of data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:
The value of this parameter must be greater than or equal to the size of the snapshot specified by the | 2000 |
Device | string | No | Note
This parameter will be removed in the future. To ensure future compatibility, we recommend that you do not use this parameter.
| null |
DiskName | string | No | The name of data disk N. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with | testDataDiskName |
Category | string | No | The category of data disk N. Valid values:
For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud. | cloud_ssd |
DeleteWithInstance | boolean | No | Specifies whether to release data disk N when the instance is released. Valid values:
Default value: true. | true |
Encrypted | string | No | Specifies whether to encrypt the data disk. | false |
AutoSnapshotPolicyId | string | No | The ID of the automatic snapshot policy to apply to data disk N. | sp-m5e7fa9ute44ssa**** |
ProvisionedIops | long | No | The provisioned read/write IOPS of the ESSD AutoPL disk to use as data disk N. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS} Baseline IOPS = min{1,800 + 50 × Capacity, 50,000} Note
This parameter is available only if you set the DataDisk.N.Category parameter to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.
| 50000 |
BurstingEnabled | boolean | No | Specifies whether to enable the performance burst feature for data disk N. Valid values:
| true |
NetworkInterface | object [] | No | The information of the ENI. | |
VSwitchId | string | No | The ID of the vSwitch to which to connect to ENI N. Take note of the following items:
| vsw-bp1s5fnvk4gn2tws0**** |
NetworkInterfaceName | string | No | The name of ENI N. Take note of the following items:
| testEniName |
Description | string | No | The description of the secondary ENI. The description must be 2 to 256 characters in length and cannot start with | testEniDescription |
SecurityGroupId | string | No | The ID of the security group to which to assign secondary ENI N. Take note of the following items:
| sg-bp15ed6xe1yxeycg**** |
PrimaryIpAddress | string | No | The primary IP address to assign to ENI N. Take note of the following items:
Note
You can attach only a single secondary ENI when you create an instance. After the instance is created, you can call the CreateNetworkInterface and AttachNetworkInterface operations to attach more secondary ENIs.
| 192.168.**.** |
SecurityGroupIds | array | No | The ID of security group N to which to assign ENI N.
Take note of the following items:
| |
string | No | The ID of security group N to which to assign ENI N.
Take note of the following items:
| sg-bp67acfmxazb4p**** | |
InstanceType | string | No | The instance type of the instance. | ecs.g5.large |
NetworkInterfaceTrafficMode | string | No | The communication mode of the primary ENI. Valid values:
| Standard |
Tag | object [] | No | The tags of the launch template. | |
Key | string | No | The key of tag N to add to the instance, EBS device, and ENI. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 64 characters in length and cannot start with | TestKey |
Value | string | No | The value of tag N to add to the instance, EBS device, and ENI. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length. It cannot start with acs: or aliyun or contain http:// or https://. | TestValue |
SecurityGroupIds | array | No | The IDs of the security groups to which to assign the instance. The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see the "Security group limits" section in Limits . Note
You cannot specify both the SecurityGroupId and SecurityGroupIds.N parameters.
| |
string | No | The ID of security group N to which to assign the instance. The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see the "Security group limits" section in Limits . Note
You cannot specify both the SecurityGroupId and SecurityGroupIds.N parameters.
| sg-bp15ed6xe1yxeycg7**** | |
DeletionProtection | boolean | No | Specifies whether to enable release protection for the instance. This parameter determines whether you can use the ECS console or call the DeleteInstance operation to release the instance. Valid values:
Default value: false. Note
This parameter is applicable only to pay-as-you-go instances. It can protect instances against manual releases, but not against automatic releases.
| false |
CreditSpecification | string | No | The performance mode of the burstable instance. Valid values:
| Standard |
Response parameters
Examples
Sample success responses
JSON
format
{
"LaunchTemplateId": "lt-m5eiaupmvm2op9d****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"LaunchTemplateVersionNumber": 2
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidRegion.NotExist | %s | The specified region does not exist. |
400 | MissingParameter | %s | A parameter is not specified. |
400 | InvalidParameter | %s | The specified parameter is invalid. |
400 | InvalidLaunchTemplateName.Malformed | The specified parameter LaunchTemplateName is not valid. | The specified LaunchTemplateName parameter is invalid. |
400 | InvalidDescription.Malformed | The specified parameter "VersionDescription" is not valid. | - |
400 | InvalidUserData.SizeExceeded | %s | The size of your specified user data exceeds the maximum allowed value. |
400 | InvalidUserData.Base64FormatInvalid | %s | The specified user data is invalid. |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | The specified tag key already exists. Tag keys must be unique. |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | The specified Tag.N.Key parameter is invalid. |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | The specified tag value is invalid. |
400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | - |
400 | InvalidParams.CreateEniParams | %s | - |
403 | LaunchTemplateLimitExceed | %s | The maximum number of launch templates has been reached. |
403 | LaunchTemplateName.Duplicated | %s | The specified launch template name already exists. |
403 | QuotaExceed.Tags | %s | The number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions. |
404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | The specified resource group does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-10-18 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||
| ||||||||||||||||||||||
2023-10-16 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||||||||||||
| ||||||||||||||||||||||
2023-08-01 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||
| ||||||||||||||||||||||
2022-07-11 | API Description Update. The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||
| ||||||||||||||||||||||
2021-12-20 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||
|