Creates an ECS-type scaling configuration for a scaling group by calling the CreateScalingConfiguration operation with the scaling group ID, instance type, instance image, and other information.
Operation description
Operation description
A scaling configuration specifies the ECS instance template used for elastic scale-out. The following instance configuration methods are supported:
-
InstancePatternInfo.N: intelligent configuration mode. You do not need to specify specific instance types. You only need to specify the number of vCPUs, memory size, instance family level, and maximum price based on your business requirements. The system automatically filters instance types that meet the requirements and preferentially selects the instance type with the lowest price to create ECS instances. This mode applies only to scaling groups whose network type is VPC, and can effectively reduce the chance of insufficient inventory for instance types during scale-out.
-
InstanceType: specifies a single instance type.
-
InstanceTypes.N: specifies multiple instance types.
-
InstanceTypeOverride.N: specifies multiple instance types and configures weights for different instance types.
-
Cpu and Memory: specifies the ranges of vCPUs and memory to define instance types. Auto Scaling determines the available instance types based on factors such as I/O optimization and zones, and creates instances with the lowest price sorted by price. This method applies only when the scaling policy of the scaling group is cost optimization and no instance type is specified in the scaling configuration.
-
You can use either of the following methods to configure the primary network interface. However, you can use only one method per API call. If you use both methods at the same time, the call fails and an error message is returned.
Use parameters such as
SecurityGroupId,SecurityGroupIds.N, andIpv6AddressCountto directly configure the primary network interface.Use
NetworkInterfaces.Nto configure the primary and secondary network interfaces. When you use this parameter, you must configure the primary network interface. IfNetworkInterfaces.N.InstanceTypeis set toPrimary, the primary network interface is configured. IfNetworkInterfaces.N.InstanceTypeis set toSecondaryor left empty, a secondary network interface is configured.
The four methods InstanceType, InstanceTypes.N, InstanceTypeOverride.N, and Cpu and Memory cannot be specified at the same time. However, InstanceType or InstanceTypes.N can be specified together with InstancePatternInfo.N. When specified together with InstancePatternInfo.N, Auto Scaling preferentially uses the instance types that you specify for scale-out. If the specified instance types are out of stock, instance types that match the InstancePatternInfo.N configuration are used.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ess:CreateScalingConfiguration |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ScalingGroupId |
string |
Yes |
The ID of the scaling group to which the scaling configuration belongs. |
asg-bp14wlu85wrpchm0**** |
| ImageId |
string |
No |
The ID of the image file. The image is used for automatic creation of ECS instances. Note
This parameter has the same effect as the |
centos6u5_64_20G_aliaegis****.vhd |
| ImageName |
string |
No |
The name of the image file. Image names are unique within a region. You cannot use this parameter to specify images from Alibaba Cloud Marketplace. Note
This parameter has the same effect as the |
image**** |
| InstanceType |
string |
No |
The instance type of the ECS instance. For more information, see Instance families. Note
The four methods InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory cannot be specified at the same time. However, InstanceType can be specified together with InstancePatternInfo. In this case, Auto Scaling preferentially uses the instance types that you specify for scale-out. If the specified instance types are out of stock, instance types that match the InstancePatternInfo configuration are used. |
ecs.g6.large |
| Cpu |
integer |
No |
The number of vCPUs. Unit: cores. You can specify both Cpu and Memory to define the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to define all instance types that have 2 vCPUs and 16 GiB of memory. Auto Scaling determines the available instance types based on factors such as I/O optimization and zones, and creates instances with the lowest price sorted by price. Note
This configuration takes effect only when the cost optimization mode is enabled and no instance type is specified in the scaling configuration. |
2 |
| Memory |
integer |
No |
The memory size. Unit: GiB. You can specify both Cpu and Memory to define the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to define all instance types that have 2 vCPUs and 16 GiB of memory. Auto Scaling determines the available instance types based on factors such as I/O optimization and zones, and creates instances with the lowest price sorted by price. Note
This configuration takes effect only when the cost optimization mode is enabled and no instance type is specified in the scaling configuration. |
16 |
| DeploymentSetId |
string |
No |
The ID of the deployment set to which the ECS instance belongs. |
ds-bp1frxuzdg87zh4pz**** |
| SecurityGroupId |
string |
No |
The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other. |
sg-280ih**** |
| IoOptimized |
string |
No |
Specifies whether the instance is an I/O optimized instance. Valid values:
The default value is none for instances of retired instance types. The default value is optimized for instances of other instance types. |
optimized |
| InternetChargeType |
string |
No |
The billing method for network usage. Valid values:
If this parameter is not specified, the default value is PayByBandwidth for the classic network and PayByTraffic for VPC. |
PayByTraffic |
| 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. Default value: 0. |
10 |
| SystemDisk.Category |
string |
No |
The category of the system cloud disk. Valid values:
This parameter cannot be specified together with |
cloud_ssd |
| SystemDisk.Size |
integer |
No |
The size of the system cloud disk. Unit: GiB. Valid values:
The value of this parameter must be greater than or equal to max{1, ImageSize}. Default value: max{40, ImageSize}. |
100 |
| SystemDisk.DiskName |
string |
No |
The name of the system cloud disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character and cannot start with |
cloud_ssdSystem |
| SystemDisk.Description |
string |
No |
The description of the system cloud disk. The description must be 2 to 256 characters in length and cannot start with |
Test system disk. |
| SystemDisk.AutoSnapshotPolicyId |
string |
No |
The ID of the automatic snapshot policy that is applied to the system cloud disk. |
sp-bp12m37ccmxvbmi5**** |
| SystemDisk.PerformanceLevel |
string |
No |
Settings for the performance level (PL) of the system cloud disk when the disk is a standard SSD. Valid values:
Default value: PL1. Note
For more information about how to select an ESSD performance level, see ESSDs. |
PL1 |
| ScalingConfigurationName |
string |
No |
The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter, digit, or Chinese character. The name must be unique among scaling configurations in the same scaling group within the same region. If you do not specify this parameter, the scaling configuration ID is used by default. |
scalingconfig**** |
| LoadBalancerWeight |
integer |
No |
The weight of the ECS instance as a backend server of the associated load balancing instance. Valid values: 1 to 100. Default value: 50. |
50 |
| Tags |
string |
No |
The tags of the ECS instance. Tags are specified as key-value pairs. You can specify up to 20 tags. The following limits apply to tag keys and values:
|
{"key1":"value1","key2":"value2", ... "key5":"value5"} |
| UserData |
string |
No |
The user data of the ECS instance. The data must be encoded in Base64. The maximum size of the raw data before encoding is 32 KB. |
ZWNobyBoZWxsbyBlY3Mh |
| KeyPairName |
string |
No |
The name of the key pair used to log on to the ECS instance.
|
KeyPairTest |
| RamRoleName |
string |
No |
The name of the RAM role associated with the ECS instance. The name is provided and maintained by RAM. You can call ListRoles to query available RAM roles. For more information about how to create a RAM role, see CreateRole. |
ramrole**** |
| SecurityEnhancementStrategy |
string |
No |
Specifies whether to enable security hardening. Valid values:
|
Active |
| InstanceName |
string |
No |
The name of the ECS instance that is created through automatic creation by using the scaling configuration. |
instance**** |
| HostName |
string |
No |
The hostname of the ECS instance. A period (.) or a hyphen (-) cannot be used as the first or last character, or used consecutively. Naming conventions vary by instance type:
|
host**** |
| SpotStrategy |
string |
No |
The preemption policy for pay-as-you-go instances. Valid values:
Default value: NoSpot. |
NoSpot |
| PasswordInherit |
boolean |
No |
Specifies whether to use the password preset in the image. To use this parameter, make sure that a password is configured for the image. Valid values:
|
false |
| Password |
string |
No |
The password of the ECS instance. The password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:
For Windows instances, the password cannot start with a forward slash (/). Note
If you specify the Password parameter, use HTTPS to send requests to avoid password leaks. |
123abc**** |
| ResourceGroupId |
string |
No |
The ID of the resource group to which the ECS instance belongs. |
rg-resource**** |
| HpcClusterId |
string |
No |
The ID of the HPC cluster to which the ECS instance belongs. |
hpc-clusterid |
| InstanceDescription |
string |
No |
The description of the ECS instance. The description must be 2 to 256 characters in length and cannot start with |
Test instance. |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. |
123e4567-e89b-12d3-a456-42665544**** |
| Ipv6AddressCount |
integer |
No |
The number of randomly generated IPv6 addresses allocated to the network interface controller (NIC). |
1 |
| CreditSpecification |
string |
No |
The running pattern of the burstable instance. Valid values:
For more information, see the performance schema section in Overview of burstable instances. |
Standard |
| ImageFamily |
string |
No |
The name of the image family. You can set this parameter to obtain the latest available image from the specified image family for instance creation. If the |
hangzhou-daily-update |
| ZoneId |
string |
No |
The zone ID of the ECS instance. |
cn-hangzhou-g |
| DedicatedHostId |
string |
No |
Specifies whether to create the ECS instance on a dedicated host. Because dedicated hosts do not support the creation of spot instances, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored when you specify the DedicatedHostId parameter. You can call DescribeDedicatedHosts to query the list of dedicated host IDs. |
dh-bp67acfmxazb4p**** |
| Affinity |
string |
No |
Specifies whether the instance on a dedicated host is associated with the dedicated host. Valid values:
Default value: default. |
default |
| Tenancy |
string |
No |
Specifies whether to create the instance on a dedicated host. Valid values:
Default value: default. |
default |
| SchedulerOptions |
object |
No |
The scheduler options. |
["testManagedPrivateSpaceId****"] |
| PrivatePoolOptions.MatchCriteria |
string |
No |
The private pool option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instances to use during startup. Valid values:
|
Open |
| PrivatePoolOptions.Id |
string |
No |
The private pool ID, which is the ID of the elasticity assurance or capacity reservation. |
eap-bp67acfmxazb4**** |
| SpotDuration |
integer |
No |
The retention period of the spot instance. Unit: hours. Valid values:
Note
Alibaba Cloud sends an ECS system event notification 5 minutes before the instance is revoked. Spot instances are billed by second. Select an appropriate retention period based on the expected task execution duration. Default value: 1. |
1 |
| SpotInterruptionBehavior |
string |
No |
The interruption pattern of the spot instance. Only Terminate (default) is supported, which directly releases the instance. |
Terminate |
| InstanceTypes |
array |
No |
The instance types. |
ecs.g6.large |
|
string |
No |
The instance types. Valid values of N: 1 to 20. You can specify up to 20 instance types in a scaling configuration. The value of N indicates the priority of the instance type. A smaller value of N indicates a higher priority. If an instance cannot be created by using the instance type with the highest priority, Auto Scaling automatically uses the instance type with the next highest priority. Note
The four methods InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory cannot be specified at the same time. However, InstanceTypes can be specified together with InstancePatternInfo. In this case, Auto Scaling preferentially uses the instance types that you specify for scale-out. If the specified instance types are out of stock, instance types that match the InstancePatternInfo configuration are used. |
ecs.g6.large |
|
| InstanceTypeOverride |
array<object> |
No |
The instance type information. |
|
|
object |
No |
The instance type information. |
||
| InstanceType |
string |
No |
To specify the capacity of an instance type in the scaling configuration, specify both this parameter and InstanceTypeOverride.N.WeightedCapacity. This parameter specifies the instance type. You can specify N values for this parameter. Combined with the InstanceTypeOverride.N.WeightedCapacity parameter, this provides the extension of multi-instance-type support with custom weights. Valid values of N: 1 to 20. Note
You cannot specify this parameter together with InstanceTypes.N or InstanceType. Valid values of InstanceType: ECS instance types that are available for purchase. For more information, see Instance families. |
ecs.c5.xlarge |
| WeightedCapacity |
integer |
No |
To specify the capacity of an instance type in the scaling configuration, first specify InstanceTypeOverride.N.InstanceType, and then specify this parameter. The two parameters must correspond one-to-one, and the values of N must be consistent. This parameter specifies the weight of the instance type, which represents the capacity of a single instance of this type in the scaling group. A larger weight means fewer instances of this type are required to meet the expected capacity. Because instance types may differ in the number of vCPUs, memory size, and other performance metrics, you can configure different weights for different instance types based on your requirements. Example:
To meet the expected capacity, the scaling group scales out 2 ecs.c5.xlarge instances. Note
During scale-out, the capacity of the scaling group cannot exceed the sum of the maximum capacity (MaxSize) and the maximum weight of the instance types. Valid values of WeightedCapacity: 1 to 500. |
4 |
| DataDisk |
array<object> |
No |
The data cloud disk information. |
|
|
object |
No |
The data cloud disk information. |
||
| PerformanceLevel |
string |
No |
Settings for the performance level (PL) of the data cloud disk when the disk is a standard SSD. The value of N must be consistent with the N in DataDisk.N.Category=cloud_essd. Valid values:
Default value: PL1. Note
For more information about how to select an ESSD performance level, see ESSDs. |
PL1 |
| AutoSnapshotPolicyId |
string |
No |
The ID of the automatic snapshot policy applied to data cloud disk N. Valid values of N: 1 to 16. |
sp-bp19nq9enxqkomib**** |
| Encrypted |
string |
No |
Specifies whether data cloud disk N is encrypted. Valid values of N: 1 to 16. Valid values:
Default value: false. |
false |
| Description |
string |
No |
The description of data cloud disk N. Valid values of N: 1 to 16. The description must be 2 to 256 characters in length and cannot start with |
Test data disk. |
| SnapshotId |
string |
No |
The ID of the snapshot used to create data cloud disk N. Valid values of N: 1 to 16. After this parameter is specified, DataDisk.N.Size is ignored, and the size of the created disk is the size of the specified snapshot. If the snapshot was created on or before July 15, 2013, the call is rejected and the error message InvalidSnapshot.TooOld is returned. |
s-280s7**** |
| Categories |
array |
No |
The disk types of data cloud disk N. The first N indicates the Nth data cloud disk. Valid values: 1 to 16. The second N indicates the Nth disk type for the data cloud disk. Valid values: 1 to 4. You can specify up to 4 disk types for a data cloud disk in a scaling configuration. A smaller value of N indicates a higher priority. If a disk type with a higher priority is unavailable, Auto Scaling automatically tries the next disk type to create the data cloud disk. Valid values:
Note
You cannot specify this parameter together with |
cloud |
|
string |
No |
The disk types of data cloud disk N. The first N indicates the Nth data cloud disk. Valid values: 1 to 16. The second N indicates the Nth disk type for the data cloud disk. Valid values: 1 to 4. You can specify up to 4 disk types for a data cloud disk in a scaling configuration. A smaller value of N indicates a higher priority. If a disk type with a higher priority is unavailable, Auto Scaling automatically tries the next disk type to create the data cloud disk. Valid values:
Note
You cannot specify this parameter together with |
cloud |
|
| Size |
integer |
No |
The size of data cloud disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:
After this parameter is specified, the disk size must be greater than or equal to the snapshot size (the snapshot is specified by SnapshotId). |
100 |
| Device |
string |
No |
The mount point of data cloud disk N. Valid values of N: 1 to 16. If you do not specify this parameter, the default behavior during automatic creation of ECS instances is that the system allocates a mount point. The mount points range from /dev/xvdb to /dev/xvdz. |
/dev/xvdb |
| DiskName |
string |
No |
The name of data cloud disk N. Valid values of N: 1 to 16. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character and cannot start with |
cloud_ssdData |
| Category |
string |
No |
The category of data cloud disk N. Valid values of N: 1 to 16. Valid values:
This parameter cannot be specified together with
|
cloud_ssd |
| DeleteWithInstance |
boolean |
No |
Specifies whether data cloud disk N is released when the instance is released. Valid values of N: 1 to 16. Valid values:
This parameter can be set only for independent cloud disks (DataDisk.N.Category is set to cloud, cloud_efficiency, cloud_ssd, cloud_essd, or cloud_auto). Otherwise, an error is returned. Default value: true. |
true |
| KMSKeyId |
string |
No |
The ID of the KMS key for data cloud disk N. Valid values of N: 1 to 16. |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| ProvisionedIops |
integer |
No |
The provisioned IOPS (Input/Output Operations Per Second) performance metrics of the data cloud disk. Note
IOPS (Input/Output Operations Per Second) measures the number of read and write (output/input) operations that a block storage device can process per second. Unit: operations per second. |
100 |
| BurstingEnabled |
boolean |
No |
Specifies whether to enable the burst (performance burst) feature for the data cloud disk. Valid values:
Note
This parameter is supported only when For more information, see ESSD AutoPL cloud disks. |
false |
| SpotPriceLimit |
array<object> |
No |
The spot instance information. |
|
|
object |
No |
The spot instance information. |
||
| PriceLimit |
number |
No |
The bid price for the spot instance. Valid values of N: 1 to 20. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit. |
0.5 |
| InstanceType |
string |
No |
The instance type of the spot instance. Valid values of N: 1 to 20. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit. |
ecs.g6.large |
| SecurityGroupIds |
array |
No |
The IDs of the security groups to which the ECS instance is added. The valid values of N depend on the maximum number of security groups to which an instance can belong. For more information, see the security group section in Limits. Note
You cannot specify both SecurityGroupId and SecurityGroupIds.N. |
sg-bp18kz60mefs**** |
|
string |
No |
The IDs of the security groups to which the ECS instance is added. The valid values of N depend on the maximum number of security groups to which an instance can belong. For more information, see the security group section in Limits. Note
You cannot specify both SecurityGroupId and SecurityGroupIds.N. |
sg-bp18kz60mefs**** |
|
| InstancePatternInfo |
array<object> |
No |
The instance type-related information in intelligent mode. |
|
|
object |
No |
The instance type-related information in intelligent mode. |
||
| Cores |
integer |
No |
The number of vCPU cores of the instance type in intelligent configuration mode. This parameter is used to filter instance types that meet the requirements. For more information, see Instance families. Valid values of N: 1 to 10. Note the following items:
|
2 |
| InstanceFamilyLevel |
string |
No |
The instance family level in intelligent configuration mode. This parameter is used to filter instance types that meet the requirements. Valid values:
Valid values of N: 1 to 10. |
EnterpriseLevel |
| MaxPrice |
number |
No |
The maximum hourly price for pay-as-you-go instances or spot instances in intelligent configuration mode. This parameter is used to filter instance types that meet the requirements. Valid values of N: 1 to 10. Note
This parameter is required if SpotStrategy is set to SpotWithPriceLimit. In other cases, this parameter is optional. |
2 |
| Memory |
number |
No |
The memory size of the instance type in intelligent configuration mode. Unit: GiB. This parameter is used to filter instance types that meet the requirements. For more information, see Instance families. Valid values of N: 1 to 10. |
4 |
| ExcludedInstanceType |
array |
No |
The instance types that you want to exclude. You can use wildcard characters (*) to exclude a single instance type or an entire instance family. Examples:
|
|
|
string |
No |
The instance types that you want to exclude. You can use wildcard characters (*) to exclude a single instance type or an entire instance family. Examples:
|
ecs.n1.small/ecs.n1.*/*7* |
|
| Architecture |
array |
No |
The architecture type of the instance type. Valid values:
Default value: all architecture types are included. |
|
|
string |
No |
The architecture type of the instance type. Valid values:
Default value: all architecture types are included. |
X86 |
|
| BurstablePerformance |
string |
No |
Specifies whether to include burstable instance types. Valid values:
Default value: Include. |
Include |
| InstanceTypeFamilies |
array |
No |
The instance families that you want to query. N indicates that you can specify multiple instance families. Valid values of N: 1 to 10. |
|
|
string |
No |
The specified instance family. N indicates that you can specify multiple instance families. Valid values of N: 1 to 10. |
ecs.g6 |
|
| MinimumCpuCoreCount |
integer |
No |
The minimum number of vCPU cores of the instance type. |
2 |
| MaximumCpuCoreCount |
integer |
No |
The maximum number of vCPU cores of the instance type. Note
The value of |
4 |
| GpuSpecs |
array |
No |
The GPU type. |
|
|
string |
No |
The GPU type. |
NVIDIA V100 |
|
| InstanceCategories |
array |
No |
The instance categorization. Valid values: Note
N indicates that you can settings multiple instance categories. Valid values of N: 1 to 10.
|
|
|
string |
No |
The instance categorization. Valid values: Note
N indicates that you can settings multiple instance categories. Valid values of N: 1 to 10.
|
Compute-optimized with GPU |
|
| CpuArchitectures |
array |
No |
The CPU architectures of the instance. Valid values: Note
N indicates that you can specify multiple CPU architectures. Valid values of N: 1 to 2.
|
|
|
string |
No |
The CPU architectures of the instance. Valid values: Note
N indicates that you can specify multiple CPU architectures. Valid values of N: 1 to 2.
|
X86 |
|
| PhysicalProcessorModels |
array |
No |
The processor models of the instance. N indicates that you can specify multiple processor models. Valid values of N: 1 to 10. |
|
|
string |
No |
The processor models of the instance. N indicates that you can specify multiple processor models. Valid values of N: 1 to 10. |
Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY |
|
| MinimumEniQuantity |
integer |
No |
The minimum number of elastic network interfaces (ENIs) that the instance supports. |
2 |
| MinimumEniPrivateIpAddressQuantity |
integer |
No |
The minimum number of IPv4 addresses per elastic network interface (ENI) of the instance. |
2 |
| MinimumEniIpv6AddressQuantity |
integer |
No |
The minimum number of IPv6 addresses per elastic network interface (ENI) of the instance. |
1 |
| MinimumInitialCredit |
integer |
No |
The minimum initial vCPU credits for burstable instances (t5 and t6). |
12 |
| MinimumBaselineCredit |
integer |
No |
The minimum baseline vCPU computing performance (sum of all vCPUs) for burstable instances (t5 and t6). |
12 |
| MinimumMemorySize |
number |
No |
The minimum memory size of the instance. Unit: GiB. |
4 |
| MaximumMemorySize |
number |
No |
The maximum memory size of the instance. Unit: GiB. |
4 |
| MinimumGpuAmount |
integer |
No |
The minimum number of GPUs of the instance. Valid values: positive integers. |
2 |
| MaximumGpuAmount |
integer |
No |
The maximum number of GPUs of the instance. Valid values: positive integers. |
2 |
| SystemDiskCategories |
array |
No |
The disk types of the system cloud disk. Valid values of N: 1 to 4. You can specify up to four disk types for the system cloud disk in a scaling configuration. A smaller value of N indicates a higher priority. When a disk type with a higher priority cannot be used, Auto Scaling automatically tries the disk type with the next priority to create the system cloud disk. Valid values:
Note
You cannot specify this parameter and |
cloud |
|
string |
No |
The disk types of the system cloud disk. Valid values of N: 1 to 4. You can specify up to four disk types for the system cloud disk in a scaling configuration. A smaller value of N indicates a higher priority. When a disk type with a higher priority cannot be used, Auto Scaling automatically tries the disk type with the next priority to create the system cloud disk. Valid values:
Note
You cannot specify this parameter and |
cloud |
|
| SystemDisk.Encrypted |
boolean |
No |
Specifies whether to encrypt the system cloud disk. Valid values:
Default value: false. |
false |
| SystemDisk.KMSKeyId |
string |
No |
The ID of the Key Management Service (KMS) key used for the system cloud disk. |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| SystemDisk.EncryptAlgorithm |
string |
No |
The encryption algorithm used for the system cloud disk. Valid values:
Default value: AES-256. |
AES-256 |
| SystemDisk.ProvisionedIops |
integer |
No |
The provisioned IOPS (Input/Output Operations Per Second) performance metrics of the system cloud disk. Note
IOPS (Input/Output Operations Per Second) measures the number of read and write (output/input) operations that a block storage device can process per second. Unit: operations per second. |
100 |
| SystemDisk.BurstingEnabled |
boolean |
No |
Specifies whether to enable the burst (performance burst) feature for the system cloud disk. Valid values:
Note
This parameter is supported only when For more information, see ESSD AutoPL cloud disks. |
false |
| ImageOptions.LoginAsNonRoot |
boolean |
No |
Specifies whether the ECS instance uses the
Default value: false. |
false |
| DeletionProtection |
boolean |
No |
The release protection property of the ECS instance. This property applies only to pay-as-you-go instances and specifies whether the instance can be directly released from the ECS console or by calling the DeleteInstance operation. Valid values:
Default value: false. Note
This property does not affect normal scale-in activities of Auto Scaling. Pay-as-you-go instances with release protection enabled can still be released during scale-in activities. |
false |
| StorageSetId |
string |
No |
The ID of the storage set. |
ss-bp67acfmxazb4p**** |
| StorageSetPartitionNumber |
integer |
No |
The maximum number of partitions in the storage set. Valid values: integers that are greater than or equal to 2. |
2 |
| CustomPriorities |
array<object> |
No |
The custom priorities of ECS instance type + vSwitch combinations. Note
This parameter takes effect only when the When an ECS instance cannot be created based on a higher-priority ECS instance type + vSwitch combination, Auto Scaling automatically selects the next-priority ECS instance type + vSwitch combination to create the ECS instance. Note
If you specify custom priorities for only some ECS instance type + vSwitch combinations, the unspecified combinations have lower priorities than the specified ones. The unspecified combinations are still prioritized based on the vSwitch order of the scaling group and the instance type order of the scaling configuration. For example, if the vSwitch order of the scaling group is vsw1 and vsw2, the instance type order of the scaling configuration is type1 and type2, and the custom priority order is |
|
|
object |
No |
The custom priorities of ECS instance type + vSwitch combinations. Important This parameter takes effect only when the scaling policy of the scaling group is set to Priority. |
||
| InstanceType |
string |
No |
The Note
This parameter takes effect only when the When an ECS instance cannot be created based on a higher-priority ECS instance type + vSwitch combination, Auto Scaling automatically selects the next-priority ECS instance type + vSwitch combination to create the ECS instance. Note
If you specify custom priorities for only some ECS instance type + vSwitch combinations, the unspecified combinations have lower priorities than the specified ones. The unspecified combinations are still prioritized based on the vSwitch order of the scaling group and the instance type order of the scaling configuration. For example, if the vSwitch order of the scaling group is vsw1 and vsw2, the instance type order of the scaling configuration is type1 and type2, and the custom priority order is |
ecs.g6.large |
| VswitchId |
string |
No |
The Note
This parameter takes effect only when the |
vsw-bp14zolna43z266bq**** |
| NetworkInterfaces |
array<object> |
No |
The list of elastic network interfaces (ENIs). |
|
|
object |
No |
The list of elastic network interfaces (ENIs). |
||
| InstanceType |
string |
No |
The type of the elastic network interface (ENI). When you use
Default value: Secondary. |
Primary |
| NetworkInterfaceTrafficMode |
string |
No |
The communication pattern of the network interface controller (NIC). Valid values:
Default value: Standard. Note
The number of elastic network interfaces (ENIs) in RDMA mode cannot exceed the limit of the instance family. For more information, see Instance families. |
HighPerformance |
| Ipv6AddressCount |
integer |
No |
The number of randomly generated IPv6 addresses for the primary ENI. Note the following items:
|
1 |
| SecurityGroupIds |
array |
No |
The IDs of one or more security groups to which the elastic network interfaces (ENIs) belongs. |
|
|
string |
No |
The IDs of one or more security groups to which the elastic network interfaces (ENIs) belongs. Note the following items:
|
sg-uf6ij8dwxh**** |
|
| SecondaryPrivateIpAddressCount |
integer |
No |
The number of secondary private IPv4 addresses to assign to the ENI. Valid values: 1 to 49.
|
2 |
| VSwitchIds |
array |
No |
The IDs of the vSwitches to which the elastic network interfaces (ENIs) belongs. N indicates that you can settings multiple vSwitches. Valid values of N: 1 to 10. Note the following items:
|
|
|
string |
No |
The IDs of the vSwitches to which the elastic network interfaces (ENIs) belongs. N indicates that you can settings multiple vSwitches. Valid values of N: 1 to 10. Note the following items:
|
vsw-bp67acfmxazb4p**** |
|
| DedicatedHostClusterId |
string |
No |
The ID of the dedicated host cluster. |
dc-2zedxc67zqzt7lb4**** |
| SecurityOptions |
object |
No |
The security options. |
|
| ConfidentialComputingMode |
string |
No |
The confidential computing mode. Valid values:
|
TDX |
| HttpEndpoint |
string |
No |
Specifies whether to enable the access channel for instance metadata. Valid values:
Default value: enabled. Note
For more information about instance metadata, see Overview of instance metadata. |
enabled |
| HttpTokens |
string |
No |
Specifies whether to forcefully use the security-enhanced mode (IMDSv2) to access instance metadata. Valid values:
Default value: optional. Note
For more information about instance metadata access modes, see Instance metadata access modes. |
optional |
| ResourcePoolOptions |
object |
No |
The resource pool policy used when creating instances. After you set this parameter, note the following items:
|
|
| Strategy |
string |
No |
Resource pools include private pools generated after Elasticity Assurance or Capacity Reservation takes effect, and public pools. These pools are available for instance startup. Valid values:
Default value: None. |
PrivatePoolFirst |
| PrivatePoolIds |
array |
No |
The IDs of private pools, which are Elasticity Assurance IDs or Capacity Reservation IDs. Only Target-mode private pool IDs can be passed in. This parameter cannot be specified together with the PrivatePoolTags parameter. |
|
|
string |
No |
The ID of a private pool, which is an Elasticity Assurance ID or Capacity Reservation ID. Only Target-mode private pool IDs can be passed in. This parameter cannot be specified together with the PrivatePoolTags parameter. Valid values of N: 1 to 20. |
eap-bp67acfmxazb4**** |
|
| PrivatePoolTags |
array<object> |
No |
Filters available Target private pools by tags. Valid values of N: 1 to 20. Note:
|
|
|
object |
No |
Filters available Target private pools by tags. Valid values of N: 1 to 20. Note:
|
||
| Key |
string |
No |
The tag key of the private pool. Filters available Target private pools by tags. Valid values of N: 1 to 20. Note: When this parameter is configured, the system filters only the Target private pools that are associated with the account, match the specified tags, and meet the scaling group constraints (such as zone and instance type). Tag matching rule: a private pool must match all specified tags. This parameter cannot be specified together with the PrivatePoolIds parameter. |
TestKey |
| Value |
string |
No |
The tag value of the private pool. |
TestValue |
| SecondaryEniVSwitchConstraint |
string |
No |
Specifies whether a vSwitch must be selected from the VSwitchIds list for the secondary elastic network interfaces (ENIs) when the VSwitchIds parameter is settings for the secondary elastic network interfaces (ENIs).
Default value: Strict. |
Strict |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| ScalingConfigurationId |
string |
The ID of the scaling configuration. |
asc-bp1ffogfdauy0nu5**** |
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
Examples
Success response
JSON format
{
"ScalingConfigurationId": "asc-bp1ffogfdauy0nu5****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.