All Products
Search
Document Center

Elastic Compute Service:CreateLaunchTemplate

Last Updated:May 15, 2024

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 the HostName parameter when you call the RunInstances operation to create instances from the launch template, the created instance still has a hostname of LocalHost. If you want to overwrite the LocalHost value of HostName provided by the launch template, you can set HostName to MyHost or another value when you call the RunInstances operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
TemplateTagobject []No

The tags to add to the launch template.

KeystringNo

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 acs: or aliyun. It cannot contain http:// or https://.

TestKey
ValuestringNo

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 acs: or aliyun. It cannot contain http:// or https://.

TestValue
LaunchTemplateNamestringYes

The name of the launch template. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

testLaunchTemplateName
VersionDescriptionstringNo

The description of the launch template version. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

testVersionDescription
ImageIdstringNo

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
ImageOwnerAliasstringNo

The source of the image. Valid values:

  • system: public image provided by Alibaba Cloud.
  • self: custom image that you created.
  • others: shared image from another Alibaba Cloud account.
  • marketplace:Alibaba Cloud Marketplace image. If Alibaba Cloud Marketplace images are available, you can use the images without the need to subscribe to the images. Take note of the billing details of Alibaba Cloud Marketplace images.
system
PasswordInheritbooleanNo

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
InstanceTypestringNo

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
SecurityGroupIdstringNo

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

The ID of the virtual private cloud (VPC).

vpc-bp12433upq1y5scen****
VSwitchIdstringNo

The ID of the vSwitch to which to connect the instance. This parameter is required if you specify the VpcId parameter.

vsw-bp1s5fnvk4gn2tws0****
InstanceNamestringNo

The name of the instance. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

testInstanceName
DescriptionstringNo

The instance description. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

testECSDescription
InternetMaxBandwidthInintegerNo

The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:

  • When the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of this parameter are 1 to 10 and the default value is 10.
  • When the purchased outbound public bandwidth is greater than 10 Mbit/s, the valid values of this parameter are 1 to the InternetMaxBandwidthOut value and the default value is the InternetMaxBandwidthOut value.
10
InternetMaxBandwidthOutintegerNo

The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.

10
HostNamestringNo

The instance hostname.

  • The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).
  • For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
testHostName
ZoneIdstringNo

The ID of the zone in which to create the instance.

cn-hangzhou-g
SystemDisk.CategorystringNo

The category of the system disk. Valid values:

  • cloud: basic disk.
  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD.
  • cloud_essd: Enterprise SSD (ESSD). You can use SystemDisk.PerformanceLevel to set the performance level of the ESSD to use as the system disk.
  • cloud_auto: ESSD AutoPL disk.
  • cloud_essd_entry: ESSD Entry disk.

For non-I/O optimized instances of retired instance types, the default value is cloud. For other types of instances, the default value is cloud_efficiency.

cloud_ssd
SystemDisk.SizeintegerNo

The size of the system disk. Unit: GiB. Valid values:

  • Valid values if you set SystemDisk.Category to cloud: 20 to 500.
  • Valid values if you set SystemDisk.Category to other disk categories: 20 to 2048.

The value of this parameter must be at least 20 and greater than or equal to the size of the image.

40
SystemDisk.DiskNamestringNo

The name of the system disk. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

testSystemDiskName
SystemDisk.DescriptionstringNo

The description of the system disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

testSystemDiskDescription
SystemDisk.IopsintegerNo
Note This parameter is in invitational preview and is unavailable for general users.
null
SystemDisk.PerformanceLevelstringNo

The performance level of the ESSD to use as the system disk. Default value: PL0. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSDs .

PL0
SystemDisk.DeleteWithInstancebooleanNo

Specifies whether to release the system disk when the instance is released. Valid values:

  • true
  • false

Default value: true.

true
SystemDisk.AutoSnapshotPolicyIdstringNo

The ID of the automatic snapshot policy to apply to the system disk.

sp-gc7c37d4ylw7mtnk****
SystemDisk.ProvisionedIopslongNo

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.BurstingEnabledbooleanNo

Specifies whether to enable the performance burst feature for the system disk. Valid values:

  • true
  • false
true
IoOptimizedstringNo

Specifies whether to create an I/O optimized instance. Valid values:

  • none: creates a non-I/O optimized instance.
  • optimized: creates an I/O optimized instance.
optimized
InstanceChargeTypestringNo

The billing method of the instance. Valid values:

  • PrePaid: subscription. If you set this parameter to PrePaid, make sure that your account has sufficient credits.Otherwise, an InvalidPayMethod error is returned.
  • PostPaid: pay-as-you-go.
PrePaid
PeriodintegerNo

The subscription duration of the instance. Unit: months. This parameter is valid and required only when InstanceChargeType is set to PrePaid. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.

1
InternetChargeTypestringNo

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth
  • PayByTraffic: pay-by-traffic
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
EnableVmOsConfigbooleanNo

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
NetworkTypestringNo

The network type of the instance. Valid values:

  • classic: classic network
  • vpc: VPC
vpc
UserDatastringNo

The user data of the instance. The user data must be encoded in Base64. The maximum size of raw data is 32 KB.

ZWNobyBoZWxsbyBlY3Mh
KeyPairNamestringNo

The name of the key pair. This parameter is empty by default.

  • For Windows instances, this parameter is ignored The Password parameter takes effect even if the KeyPairName parameter is specified.
  • For Linux instances, the password-based logon method is disabled by default.
testKeyPairName
RamRoleNamestringNo

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
AutoReleaseTimestringNo

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.

  • If the value of ss is not 00, the time is automatically rounded down to the nearest minute based on the value of mm.
  • The specified time must be at least 30 minutes later than the current time.
  • The specified time can be at most three years later than the current time.
2018-01-01T12:05:00Z
SpotStrategystringNo

The bidding policy for the pay-as-you-go instance. This parameter is valid only when the InstanceChargeType parameter is set to PostPaid. Valid values:

  • NoSpot: The instance is a regular pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.
NoSpot
SpotPriceLimitfloatNo

The maximum hourly price of the instance. The value is accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.

0.97
SpotDurationintegerNo

The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values:

  • 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.
  • 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.

Alibaba Cloud sends an ECS system event 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 This parameter takes effect only if SpotStrategy is set to SpotWithPriceLimit or SpotAsPriceGo.
1
ResourceGroupIdstringNo

The ID of the resource group to which to assign the instance, Elastic Block Storage (EBS) device, and elastic network interface (ENI).

rg-bp67acfmxazb4p****
TemplateResourceGroupIdstringNo

The ID of the resource group to which the launch template belongs.

rg-bp67acfmxazb4p****
SecurityEnhancementStrategystringNo

Specifies whether to enable security hardening for the operating system. Valid values:

  • Active: enables security hardening. This value is applicable only to public images.
  • Deactive: does not enable security hardening. This value is applicable to all images.
Deactive
PrivateIpAddressstringNo

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 VSwitchId parameter.

10.1.**.**
DeploymentSetIdstringNo

The ID of the deployment set to which to deploy the instance.

ds-bp1brhwhoqinyjd6****
Ipv6AddressCountintegerNo

The number of IPv6 addresses to randomly generate for the primary elastic network interface (ENI). Valid values: 1 to 10.

1
DataDiskobject []No

The data disks.

PerformanceLevelstringNo

The performance level of the ESSD to use as data disk N. The value of N must be the same as that in DataDisk.N.Category when DataDisk.N.Category is set to cloud_essd. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1 (default): A single ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.

For information about ESSD performance levels, see ESSDs .

PL1
DescriptionstringNo

The description of data disk N. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

testDataDiskDescription
SnapshotIdstringNo

The ID of the snapshot to use to create data disk N. Valid values of N: 1 to 16. If you specify DataDisk.N.SnapshotId, DataDisk.N.Size is ignored. The data disk is created with the size of the specified snapshot.

Note Use snapshots created on or after July 15, 2013. Otherwise, an error is returned and your request is rejected.
s-bp17441ohwka0yuh****
SizeintegerNo

The size of data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:

  • Valid values if you set DataDisk.N.Category to cloud: 5 to 2000.

  • Valid values if you set DataDisk.N.Category to cloud_efficiency: 20 to 32768.

  • Valid values if you set DataDisk.N.Category to cloud_ssd: 20 to 32768.

  • Valid values if you set DataDisk.N.Category to cloud_essd: vary based on the value of DataDisk.N.PerformanceLevel.

    • Valid values if you set DataDisk.N.PerformanceLevel to PL0: 1 to 32768.
    • Valid values if you set DataDisk.N.PerformanceLevel to PL1: 20 to 32768.
    • Valid values if you set DataDisk.N.PerformanceLevel to PL2: 461 to 32768.
    • Valid values if you set DataDisk.N.PerformanceLevel to PL3: 1261 to 32768.
  • Valid values if you set DataDisk.N.Category to cloud_auto: 1 to 32768.

  • Valid values if you set DataDisk.N.Category to cloud_essd_entry: 10 to 32768.

The value of this parameter must be greater than or equal to the size of the snapshot specified by DataDisk.N.SnapshotId.

2000
DevicestringNo
Note This parameter will be removed in the future. We recommend that you do not use this parameter to ensure future compatibility.
null
DiskNamestringNo

The name of data disk N. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

testDataDiskName
CategorystringNo

The category of data disk N. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • cloud_auto: ESSD AutoPL disk
  • cloud_essd_entry: ESSD Entry disk

For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud.

cloud_ssd
DeleteWithInstancebooleanNo

Specifies whether to release data disk N when the instance is released. Valid values:

  • true
  • false

Default value: true.

true
EncryptedstringNo

Specifies whether to encrypt data disk N.

false
AutoSnapshotPolicyIdstringNo

The ID of the automatic snapshot policy to apply to data disk N.

sp-m5e7fa9ute44ssa****
ProvisionedIopslongNo

The provisioned read/write IOPS of the ESSD AutoPL 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 DataDisk.N.Category to cloud_auto. For more information, see ESSD AutoPL disks and Modify the performance configurations of an ESSD AutoPL disk.
50000
BurstingEnabledbooleanNo

Specifies whether to enable the performance burst feature for data disk N. Valid values:

  • true
  • false
true
NetworkInterfaceobject []No

The information of the ENIs.

VSwitchIdstringNo

The ID of the vSwitch to which to connect ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. In this case, this parameter is equivalent to VSwitchId. You cannot specify both NetworkInterface.N.VSwitchId and VSwitchId.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the VSwitchId value.
vsw-bp1s5fnvk4gn2tws0****
NetworkInterfaceNamestringNo

The name of ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, you do not need to set this parameter.
testEniName
DescriptionstringNo

The description of the secondary ENI. The description must be 2 to 256 characters in length and cannot start with http:// or https://. The value of N in NetworkInterface.N cannot be greater than 1.

testEniDescription
SecurityGroupIdstringNo

The ID of the security group to which to assign ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, you must set this parameter. In this case, this parameter is equivalent to SecurityGroupId. You cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupIds.N.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the ID of the security group to which to assign the instance.
sg-bp15ed6xe1yxeycg****
PrimaryIpAddressstringNo

The primary IP address to assign to ENI N.

Take note of the following items:

  • Valid values of N: 1 and 2.

    • If the value of N is 1, you can configure a primary or secondary ENI. If this parameter is specified, Amount is set to a numeric value greater than 1, and NetworkInterface.N.InstanceType is set to Primary, the specified number of instances are created and consecutive primary IP addresses starting from the specified one are assigned to the instances. In this case, you cannot attach secondary ENIs to the instances.
    • If the value of N is 2, you can configure a primary ENI and a secondary ENI. If this parameter is specified, Amount is set to a numeric value greater than 1, and NetworkInterface.N.InstanceType is set to Primary, you cannot set NetworkInterface.2.InstanceType to Secondary to attach a secondary ENI.
  • If NetworkInterface.N.InstanceType is set to Primary, this parameter is equivalent to PrivateIpAddress. You cannot specify both this parameter and PrivateIpAddress.

  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, the specified primary IP address is assigned to the secondary ENI. The default value is an IP address that is randomly selected from within the CIDR block of the vSwitch to which to connect the secondary ENI.

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

The ID of security group N to which to assign ENI N.

  • Valid values of the first N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • The second N indicates that one or more security group IDs can be specified. The valid values of N vary based on the maximum number of security groups to which an instance can belong. For more information, see the Security group limits section of the "Limits" topic.

Take note of the following items:

  • If NetworkInterface.N.InstanceType is set to Primary, you must specify this parameter or NetworkInterface.N.SecurityGroupId. In this case, this parameter is equivalent to SecurityGroupIds.N. You cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the ID of the security group to which to assign the instance.
stringNo

The ID of security group N to which to assign ENI N.

  • Valid values of the first N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.
  • The second N indicates that one or more security group IDs can be specified. The valid values of N vary based on the maximum number of security groups to which an instance can belong. For more information, see the Security group limits section of the "Limits" topic.

Take note of the following items:

  • If NetworkInterface.N.InstanceType is set to Primary, you must specify this parameter or NetworkInterface.N.SecurityGroupId. In this case, this parameter is equivalent to SecurityGroupIds.N. You cannot specify SecurityGroupId, SecurityGroupIds.N, or NetworkInterface.N.SecurityGroupId.
  • If NetworkInterface.N.InstanceType is set to Secondary or left empty, this parameter is optional. The default value is the ID of the security group to which to assign the instance.
sg-bp67acfmxazb4p****
InstanceTypestringNo

The type of ENI N. Valid values of N: 1 and 2. If the value of N is 1, you can configure a primary or secondary ENI. If the value of N is 2, you must configure a primary ENI and a secondary ENI.

Valid values:

  • Primary
  • Secondary

Default value: Secondary.

ecs.g5.large
NetworkInterfaceTrafficModestringNo

The communication mode of the primary ENI. Valid values:

  • Standard: uses the TCP communication mode.
  • HighPerformance: uses the remote direct memory access (RDMA) communication mode with Elastic RDMA Interface (ERI) enabled.
Standard
Tagobject []No

The tags of the launch template.

KeystringNo

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 acs: or aliyun. It cannot contain http:// or https://.

TestKey
ValuestringNo

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
SecurityGroupIdsarrayNo

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.
stringNo

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****
SystemDisk.EncryptedstringNo

Specifies whether to encrypt the system disk. Valid values:

  • true
  • false

Default value: false.

Note If you create an instance in Hong Kong Zone D or Singapore Zone A, you cannot encrypt the system disk.
false
DeletionProtectionbooleanNo

Specifies whether to enable release protection for the instance. This parameter specifies whether you can use the ECS console or call the DeleteInstance operation to release the instance. Valid values:

  • true
  • false

Default value: false.

Note This parameter is applicable only to pay-as-you-go instances. The release protection feature can protect instances against manual releases, but not against automatic releases.
false
CreditSpecificationstringNo

The performance mode of the burstable instance. Valid values:

Standard

Response parameters

ParameterTypeDescriptionExample
object
LaunchTemplateIdstring

The ID of the launch template.

lt-m5eiaupmvm2op9d****
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
LaunchTemplateVersionNumberlong

The version number of the launch template.

2

Examples

Sample success responses

JSONformat

{
  "LaunchTemplateId": "lt-m5eiaupmvm2op9d****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "LaunchTemplateVersionNumber": 2
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidRegion.NotExist%sThe specified region does not exist.
400MissingParameter%sA parameter is not specified.
400InvalidParameter%sThe specified parameter is invalid.
400InvalidLaunchTemplateName.MalformedThe specified parameter LaunchTemplateName is not valid.The specified LaunchTemplateName parameter is invalid.
400InvalidDescription.MalformedThe specified parameter "VersionDescription" is not valid.-
400InvalidUserData.SizeExceeded%sThe size of your specified user data exceeds the maximum allowed value.
400InvalidUserData.Base64FormatInvalid%sThe specified user data is invalid.
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
400InvalidParams.CreateEniParams%s-
403LaunchTemplateLimitExceed%sThe maximum number of launch templates has been reached.
403LaunchTemplateName.Duplicated%sThe specified launch template name already exists.
403QuotaExceed.Tags%sThe number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.The specified resource group does not exist.
500InternalErrorThe 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 timeSummary of changesOperation
2023-10-18The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CreditSpecification
2023-10-16The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.
2023-08-01The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DeletionProtection
2022-07-11API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: SystemDisk.AutoSnapshotPolicyId
    Added Input Parameters: SystemDisk.ProvisionedIops
    Added Input Parameters: SystemDisk.BurstingEnabled
2021-12-20The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Ipv6AddressCount