Call the CreateScalingConfiguration operation and specify parameters such as the scaling group ID, instance type, and image to create an ECS-based scaling configuration for a scaling group.
Operation description
A scaling configuration defines the template for ECS instances that are created during scale-out events. The following instance configuration methods are supported:
InstancePatternInfo.N: In intelligent configuration mode, you do not need to specify an instance type. Instead, you can specify the number of vCPUs, memory size, instance family level, and maximum price based on your business needs. The system automatically filters for eligible instance types and prioritizes the one with the lowest price to create ECS instances. This mode applies only when the network type of the scaling group is a VPC. This mode effectively reduces scale-out failures that are caused by insufficient inventory of specific instance types.
InstanceType: Specify a single instance type.
InstanceTypes.N: Specify multiple instance types.
InstanceTypeOverride.N: Specify multiple instance types and assign a weight to each instance type.
Cpu and Memory: Define a range of instance types by specifying CPU and memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, and then creates instances using the lowest-priced option. 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 bind a primary elastic network interface (ENI) using one of the following methods. Note that you must 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.
Directly configure the primary ENI by setting parameters such as
SecurityGroupId,SecurityGroupIds.N, andIpv6AddressCount.Configure the primary and secondary ENIs by setting the
NetworkInterfaces.Nparameter. When you use this parameter, you must configure the primary ENI. IfNetworkInterfaces.N.InstanceTypeis set toPrimary, the primary ENI is configured. IfNetworkInterfaces.N.InstanceTypeis set toSecondaryor left empty, a secondary ENI is configured.
You cannot specify InstanceType, InstanceTypes.N, InstanceTypeOverride.N, Cpu, and Memory at the same time. However, you can specify InstanceType or InstanceTypes.N together with InstancePatternInfo.N. In this case, Auto Scaling prioritizes the specified instance types for scale-out events. If those instance types are out of stock, Auto Scaling uses instance types that match the InstancePatternInfo.N configuration.
Try it now
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | CreateScalingConfiguration | A required parameter. Set the value to CreateScalingConfiguration. |
ScalingGroupId | String | Yes | asg-bp14wlu85wrpchm0**** | The ID of the scaling group to which the scaling configuration belongs. |
ImageId | String | No | centos6u5_64_20G_aliaegis****.vhd | The ID of the image file used to automatically create instances. Note This parameter serves the same purpose as the ImageName parameter. You can specify either one. If you set |
ImageName | String | No | image**** | The name of the image file. Image names must be unique within a region. You cannot use this parameter to specify images from Alibaba Cloud Marketplace. Note This parameter serves the same purpose as the |
InstanceType | String | No | ecs.g6.large | An ECS instance type. For more information, see Instance families. Note You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, Cpu, and Memory at the same time. However, you can specify InstanceType together with InstancePatternInfo. In this case, Auto Scaling prioritizes your specified instance type for scale-outs. If the specified instance type is out of stock, it uses an instance type that matches the InstancePatternInfo configuration. |
Cpu | Integer | No | 2 | The number of vCPUs. Unit: cores. Specifying both Cpu and Memory defines a range of instance types. For example, Cpu=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, then creates the instance with the lowest price. Note This range-based configuration takes effect only in cost optimization mode and when no instance type is specified in the scaling configuration. |
Memory | Integer | No | 16 | The memory size. Unit: GiB. Specifying both Cpu and Memory defines a range of instance types. For example, Cpu=2 and Memory=16 defines all instance types with 2 vCPUs and 16 GiB of memory. Auto Scaling determines the set of available instance types based on factors such as I/O optimization and zones, then creates the instance with the lowest price. Note This range-based configuration takes effect only in cost optimization mode and when no instance type is specified in the scaling configuration. |
DeploymentSetId | String | No | ds-bp1frxuzdg87zh4pz**** | The ID of the deployment set to which the ECS instance belongs. |
SecurityGroupId | String | No | sg-280ih**** | The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other. |
IoOptimized | String | No | optimized | Specifies whether the instance is I/O optimized. Valid values:
The default value for instances of retired instance types is none. For other instance types, the default value is optimized. |
InternetChargeType | String | No | PayByTraffic | The billing method for network usage. Valid values:
If you do not specify this parameter, the default value is PayByBandwidth for classic network instances and PayByTraffic for VPC instances. |
InternetMaxBandwidthIn | Integer | No | 10 | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:
|
InternetMaxBandwidthOut | Integer | No | 10 | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0. |
SystemDisk.Category | String | No | cloud_ssd | The category of the system disk. Valid values:
You cannot specify this parameter and |
SystemDisk.Size | Integer | No | 100 | The size of the system disk. Unit: GiB. Valid values:
The value must be greater than or equal to max{1, ImageSize}. Default value: max{40, ImageSize}. |
SystemDisk.DiskName | String | No | cloud_ssdSystem | The name of the system disk. The name must be 2 to 128 characters in length and can contain letters and Chinese characters. It must start with a letter or a Chinese character and cannot start with |
SystemDisk.Description | String | No | Test system disk. | The description of the system disk. The description must be 2 to 256 characters in length and can contain letters and Chinese characters. It cannot start with |
SystemDisk.AutoSnapshotPolicyId | String | No | sp-bp12m37ccmxvbmi5**** | The ID of the automatic snapshot policy applied to the system disk. |
SystemDisk.PerformanceLevel | String | No | PL1 | The performance level (PL) of the ESSD system disk. Valid values:
Default value: PL1. Note For more information about how to select an ESSD PL, see ESSDs. |
ScalingConfigurationName | String | No | scalingconfig**** | The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, Chinese characters, underscores (_), hyphens (-), and periods (.). It must start with a letter, digit, or Chinese character. The name must be unique within a scaling group in the same region. If you do not specify this parameter, the scaling configuration ID is used by default. |
LoadBalancerWeight | Integer | No | 50 | The weight of the ECS instance as a backend server for Server Load Balancer. Valid values: 1 to 100. Default value: 50. |
Tags | String | No | {"key1":"value1","key2":"value2", ... "key5":"value5"} | The tags of the ECS instance. Tags are passed as key-value pairs. You can specify up to 20 tags. Requirements for keys and values:
|
UserData | String | No | ZWNobyBoZWxsbyBlY3Mh | The user data of the ECS instance. The user data must be Base64-encoded. The raw data before encoding cannot exceed 32 KB. |
KeyPairName | String | No | KeyPairTest | The name of the key pair used to log on to the ECS instance.
|
RamRoleName | String | No | ramrole**** | The name of the RAM role for the ECS instance. RAM role names are provided and maintained by RAM. You can call ListRoles to query available RAM roles. For information about creating a RAM role, see CreateRole. |
SecurityEnhancementStrategy | String | No | Active | Specifies whether to enable security hardening. Valid values:
|
InstanceName | String | No | instance**** | The name of ECS instances automatically created using this scaling configuration. |
HostName | String | No | host**** | The hostname of the ECS instance. A period (.) or hyphen (-) cannot be the first or last character, and cannot appear consecutively. Naming requirements vary by instance type:
|
SpotStrategy | String | No | NoSpot | The preemption policy for a pay-as-you-go instance. Valid values:
Default value: NoSpot. |
PasswordInherit | Boolean | No | false | Specifies whether to use the password preset in the image. If you use this parameter, ensure the image has a password set. Valid values:
|
Password | String | No | 123abc**** | The password of the ECS instance. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include the following: For Windows instances, the password cannot start with a forward slash (/). Note If you pass the Password parameter, use HTTPS to send the request to prevent password leakage. |
ResourceGroupId | String | No | rg-resource**** | The ID of the resource group to which the ECS instance belongs. |
HpcClusterId | String | No | hpc-clusterid | The ID of the HPC cluster to which the ECS instance belongs. |
InstanceDescription | String | No | Test instance. | The description of the ECS instance. The description must be 2 to 256 characters in length and can contain letters and Chinese characters. It cannot start with |
ClientToken | String | No | 123e4567-e89b-12d3-a456-42665544**** | Ensures request idempotence. Generate a unique parameter value from your client to ensure uniqueness across different requests. This parameter supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. |
Ipv6AddressCount | Integer | No | 1 | The number of randomly generated IPv6 addresses to assign to the ENI. |
CreditSpecification | String | No | Standard | The performance mode of a burstable instance. Valid values:
For more information, see the Performance modes section in Overview of burstable instances. |
ImageFamily | String | No | hangzhou-daily-update | The name of the image family. Setting this parameter retrieves the latest available image within the current image family to create an instance. If you have already set the |
ZoneId | String | No | cn-hangzhou-g | The ID of the zone to which the ECS instance belongs. |
DedicatedHostId | String | No | dh-bp67acfmxazb4p**** | Specifies whether to create an ECS instance on a Dedicated Host. Because Dedicated Hosts do not support spot instances, if you specify the DedicatedHostId parameter, the SpotStrategy and SpotPriceLimit settings in the request are automatically ignored. You can call DescribeDedicatedHosts to query the list of Dedicated Host IDs. |
Affinity | String | No | default | Specifies whether to associate the Dedicated Host instance with the Dedicated Host. Valid values:
Default value: default. |
Tenancy | String | No | default | Specifies whether to create the instance on a Dedicated Host. Valid values:
Default value: default. |
SchedulerOptions | Map | No | ["testManagedPrivateSpaceId****"] | The scheduling options. |
PrivatePoolOptions.MatchCriteria | String | No | Open | The private pool capacity option for instance launch. After an elasticity assurance or capacity reservation takes effect, it generates private pool capacity that you can select when launching an instance. Valid values:
|
PrivatePoolOptions.Id | String | No | eap-bp67acfmxazb4**** | The ID of the private pool. This is the ID of the elasticity assurance or capacity reservation. |
SpotDuration | Integer | No | 1 | The protection period of the spot instance. Unit: hours. Valid values:
Default value: 1. |
SpotInterruptionBehavior | String | No | Terminate | The interruption mode of the spot instance. Only Terminate (default) is supported, which directly releases the instance. |
InstanceTypes.N | String | No | ecs.g6.large | Multiple instance type parameters. N ranges from 1 to 20, meaning you can specify up to 20 instance types in a scaling configuration. N represents the priority of the instance type in the current scaling configuration. The instance type with N=1 has the highest priority. Priority decreases as N increases. If an instance cannot be created with a higher-priority instance type, Auto Scaling automatically selects the next-priority instance type. Note You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, Cpu, and Memory at the same time. However, you can specify InstanceTypes together with InstancePatternInfo. In this case, Auto Scaling prioritizes your specified instance types for scale-outs. If those instance types are out of stock, it uses instance types that match the InstancePatternInfo configuration. |
InstanceTypeOverride.N.InstanceType | String | No | ecs.c5.xlarge | 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 of this parameter, combined with InstanceTypeOverride.N.WeightedCapacity, to extend multi-instance type support with custom weights. N ranges from 1 to 20. Note When you specify this parameter, you cannot specify InstanceTypes.N or InstanceType at the same time. For valid values of InstanceType, see Instance families. |
InstanceTypeOverride.N.WeightedCapacity | Integer | No | 4 | To specify the capacity of an instance type in the scaling configuration, specify this parameter after specifying InstanceTypeOverride.N.InstanceType. The two parameters correspond one-to-one, and N must be consistent. This parameter specifies the weight of the instance type, indicating the capacity size of a single instance of this type in the scaling group. A larger weight means fewer instances of this type are needed to meet the desired capacity. Because performance metrics such as the number of vCPUs and memory size vary for each instance type, you can configure different weights based on your needs. Example:
To meet the desired capacity, the scaling group scales out two ecs.c5.xlarge instances. Note During scale-out, the scaling group capacity cannot exceed the sum of the maximum capacity (MaxSize) and the maximum weight of the instance type. WeightedCapacity ranges from 1 to 500. |
DataDisk.N.PerformanceLevel | String | No | PL1 | The performance level (PL) of the ESSD data disk. The value of N must match the N in DataDisk.N.Category=cloud_essd. Valid values:
Default value: PL1. Note For more information about how to select an ESSD PL, see ESSDs. |
DataDisk.N.AutoSnapshotPolicyId | String | No | sp-bp19nq9enxqkomib**** | The ID of the automatic snapshot policy applied to the data disk. N ranges from 1 to 16. |
DataDisk.N.Encrypted | String | No | false | Specifies whether to encrypt data disk N. N ranges from 1 to 16. Valid values:
Default value: false. |
DataDisk.N.Description | String | No | Test data disk. | The description of data disk N. N ranges from 1 to 16. The description must be 2 to 256 characters in length and can contain letters and Chinese characters. It cannot start with |
DataDisk.N.SnapshotId | String | No | s-280s7**** | The snapshot used to create the data disk. N ranges from 1 to 16. After you specify this parameter, DataDisk.N.Size is ignored, and the actual disk size created equals the size of the specified snapshot. If the snapshot was created on or before July 15, 2013, the call is rejected and returns InvalidSnapshot.TooOld. |
DataDisk.N.Categories.N | String | No | cloud | Multiple disk types for data disk N. The first N indicates the Nth data disk (range: 1 to 16). The second N indicates the Nth disk type for the Nth data disk (range: 1 to 4), meaning you can specify up to four disk types for a data disk in a scaling configuration. A smaller N indicates higher priority. If a disk cannot be created using a higher-priority disk type, Auto Scaling automatically tries the next-priority disk type. Valid values:
Note When you specify this parameter, you cannot specify |
DataDisk.N.Size | Integer | No | 100 | The size of data disk N. N ranges from 1 to 16. Unit: GiB. Valid values:
After you specify this parameter, the disk size must be greater than or equal to the snapshot size (specified by SnapshotId). |
DataDisk.N.Device | String | No | /dev/xvdb | The mount point of the data disk. N ranges from 1 to 16. If you do not specify this parameter, the system automatically assigns a mount point when creating the ECS instance, starting from /dev/xvdb and ending at /dev/xvdz. |
DataDisk.N.DiskName | String | No | cloud_ssdData | The name of data disk N. N ranges from 1 to 16. The name must be 2 to 128 characters in length and can contain letters and Chinese characters. It must start with a letter or a Chinese character and cannot start with |
DataDisk.N.Category | String | No | cloud_ssd | The category of data disk N. N ranges from 1 to 16. Valid values:
You cannot specify this parameter and
|
DataDisk.N.DeleteWithInstance | Boolean | No | true | Specifies whether to release the data disk when the instance is released. N ranges from 1 to 16. Valid values:
This parameter applies only to standalone disks (DataDisk.N.Category is cloud, cloud_efficiency, cloud_ssd, cloud_essd, or cloud_auto). Otherwise, an error occurs. Default value: true. |
DataDisk.N.KMSKeyId | String | No | 0e478b7a-4262-4802-b8cb-00d3fb40**** | The ID of the KMS key for the data disk. N ranges from 1 to 16. |
DataDisk.N.ProvisionedIops | Long | No | 100 | The provisioned IOPS (input/output operations per second) performance metric of the data disk. Note IOPS refers to the number of I/O operations a block storage device can process per second, representing its read and write capability. Unit: operations per second. |
DataDisk.N.BurstingEnabled | Boolean | No | false | Specifies whether to enable Burst (performance bursting) for the data disk. Valid values:
For more information, see ESSD AutoPL disks. |
SpotPriceLimit.N.PriceLimit | Float | No | 0.5 | The bid price for the spot instance. N ranges from 1 to 20. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit. |
SpotPriceLimit.N.InstanceType | String | No | ecs.g6.large | The instance type of the spot instance. N ranges from 1 to 20. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit. |
SecurityGroupIds.N | String | No | sg-bp18kz60mefs**** | Adds the ECS instance to multiple security groups simultaneously. The range of N depends on the maximum number of security groups an instance can join. For more information, see the Security group section in Limits. Note You cannot specify SecurityGroupId and SecurityGroupIds.N at the same time. |
InstancePatternInfo.N.Cores | Integer | No | 2 | In intelligent configuration mode, this is the number of vCPU cores for the instance type, used to filter eligible instance types. For more information, see Instance families. N ranges from 1 to 10. Note the following:
|
InstancePatternInfo.N.InstanceFamilyLevel | String | No | EnterpriseLevel | In intelligent configuration mode, this is the instance family level, used to filter eligible instance types. Valid values:
N ranges from 1 to 10. |
InstancePatternInfo.N.MaxPrice | Float | No | 2 | In intelligent configuration mode, this is the maximum hourly price you accept for a pay-as-you-go or spot instance, used to filter eligible instance types. N ranges from 1 to 10. Note This parameter is required when SpotStrategy is set to SpotWithPriceLimit. In other cases, it is optional. |
InstancePatternInfo.N.Memory | Float | No | 4 | In intelligent configuration mode, this is the memory size of the instance type, used to filter eligible instance types. Unit: GiB. For more information, see Instance families. N ranges from 1 to 10. |
InstancePatternInfo.N.ExcludedInstanceType.N | String | No | ecs.n1.small/ecs.n1.*/*7* | The instance types to exclude. Use a wildcard character (*) to exclude a single type or an entire family. Examples:
|
InstancePatternInfo.N.Architecture.N | String | No | X86 | The architecture type of the instance type. Valid values:
Default value: Includes all architecture types. |
InstancePatternInfo.N.BurstablePerformance | String | No | Include | Specifies whether the instance type is a burstable instance. Valid values:
Default value: Include. |
InstancePatternInfo.N.InstanceTypeFamilies.N | String | No | ecs.g6 | The specified instance families. N indicates you can set multiple instance families. N ranges from 1 to 10. |
InstancePatternInfo.N.MinimumCpuCoreCount | Integer | No | 2 | The minimum number of vCPU cores for the instance type. |
InstancePatternInfo.N.MaximumCpuCoreCount | Integer | No | 4 | The maximum number of vCPU cores for the instance type. Note
|
InstancePatternInfo.N.GpuSpecs.N | String | No | NVIDIA V100 | The GPU type. |
InstancePatternInfo.N.InstanceCategories.N | String | No | Compute-optimized with GPU | The instance classification. Valid values: Note N indicates you can set multiple instance classifications. N ranges from 1 to 10.
|
InstancePatternInfo.N.CpuArchitectures.N | String | No | X86 | The CPU architecture of the instance. Valid values: Note N indicates you can set multiple CPU architectures. N ranges from 1 to 2.
|
InstancePatternInfo.N.PhysicalProcessorModels.N | String | No | Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY | The processor model of the instance. N indicates you can set multiple processor models. N ranges from 1 to 10. |
InstancePatternInfo.N.MinimumEniQuantity | Integer | No | 2 | The maximum number of elastic network interfaces (ENIs) that can be attached to an instance. |
InstancePatternInfo.N.MinimumEniPrivateIpAddressQuantity | Integer | No | 2 | The maximum number of IPv4 addresses per elastic network interface (ENI) on the instance. |
InstancePatternInfo.N.MinimumEniIpv6AddressQuantity | Integer | No | 1 | The maximum number of IPv6 addresses per Elastic Network Interface (ENI) on an instance. |
InstancePatternInfo.N.MinimumInitialCredit | Integer | No | 12 | The minimum initial vCPU credits for a t5 or t6 burstable instance. |
InstancePatternInfo.N.MinimumBaselineCredit | Integer | No | 12 | The minimum baseline vCPU computing performance (sum of all vCPUs) for a t5 or t6 burstable instance. |
InstancePatternInfo.N.MinimumMemorySize | Float | No | 4 | The minimum memory size of the instance. Unit: GiB. |
InstancePatternInfo.N.MaximumMemorySize | Float | No | 4 | The maximum memory size of the instance. Unit: GiB. |
InstancePatternInfo.N.MinimumGpuAmount | Integer | No | 2 | The minimum number of GPUs for the instance. The value must be a positive integer. |
InstancePatternInfo.N.MaximumGpuAmount | Integer | No | 2 | The maximum number of GPUs for the instance. The value must be a positive integer. |
SystemDiskCategories.N | String | No | cloud | Multiple disk types for the system disk. N ranges from 1 to 4, meaning you can specify up to four disk types for the system disk in a scaling configuration. A smaller N indicates higher priority. If a disk cannot be created using a higher-priority disk type, Auto Scaling automatically tries the next-priority disk type. Valid values:
Note When you specify this parameter, you cannot specify |
SystemDisk.Encrypted | Boolean | No | false | Specifies whether to encrypt the system disk. Valid values:
Default value: false. |
SystemDisk.KMSKeyId | String | No | 0e478b7a-4262-4802-b8cb-00d3fb40**** | The ID of the KMS key used for the system disk. |
SystemDisk.EncryptAlgorithm | String | No | AES-256 | The encryption algorithm used for the system disk. Valid values:
Default value: AES-256. |
SystemDisk.ProvisionedIops | Long | No | 100 | The provisioned IOPS (input/output operations per second) performance metric of the system disk. Note IOPS refers to the number of I/O operations a block storage device can process per second, representing its read and write capability. Unit: operations per second. |
SystemDisk.BurstingEnabled | Boolean | No | false | Specifies whether to enable Burst (performance bursting) for the system disk. Valid values:
For more information, see ESSD AutoPL disks. |
ImageOptions.LoginAsNonRoot | Boolean | No | false | Specifies whether to log on to the ECS instance as the
Default value: false. |
DeletionProtection | Boolean | No | false | The release protection attribute of the ECS instance. This applies only to pay-as-you-go instances and indicates whether the instance can be directly released through the ECS console or API (DeleteInstance). Valid values:
Default value: false. Note This attribute does not affect normal scale-in activities in Auto Scaling. During a scale-in event, a pay-as-you-go instance with release protection enabled can still be released normally. |
StorageSetId | String | No | ss-bp67acfmxazb4p**** | The ID of the storage set. |
StorageSetPartitionNumber | Integer | No | 2 | The maximum number of partitions in the storage set. The value must be an integer greater than or equal to 2. |
CustomPriorities.N.InstanceType | String | No | ecs.g6.large | The Note This parameter is valid only when the scaling group's If an ECS instance cannot be created based on a higher-priority ECS instance type + virtual switch combination, Auto Scaling automatically selects the next-priority combination. Note If you specify custom priorities for only some ECS instance type + virtual switch combinations, the unspecified combinations have lower priority than the specified ones. Unspecified combinations are still prioritized based on the order of virtual switches in the scaling group and the order of instance types in the scaling configuration. Example: If the virtual switch order in the scaling group is vsw1, vsw2, and the instance type order in the scaling configuration is type1, type2, and the custom priority order is |
CustomPriorities.N.VswitchId | String | No | vsw-bp14zolna43z266bq**** | The Note This parameter is valid only when the scaling policy of the scaling group is set to Priority Policy. The vSwitch must also be included in the vSwitch list of the scaling group. |
NetworkInterfaces.N.InstanceType | String | No | Primary | The type of the ENI. When using
Default value: Secondary. |
NetworkInterfaces.N.NetworkInterfaceTrafficMode | String | No | HighPerformance | The communication mode of the network interface. Valid values:
Default value: Standard. Note The number of ENIs in RDMA mode cannot exceed the limit for the instance family. For more information, see Instance families. |
NetworkInterfaces.N.Ipv6AddressCount | Integer | No | 1 | The number of randomly generated IPv6 addresses to assign to the primary ENI. Note the following:
|
NetworkInterfaces.N.SecurityGroupIds.N | String | No | sg-uf6ij8dwxh**** | One or more security group IDs to which the ENI belongs. Note the following:
|
NetworkInterfaces.N.SecondaryPrivateIpAddressCount | Integer | No | 2 | The number of secondary private IPv4 addresses to assign to the ENI. Valid values: 1 to 49.
|
DedicatedHostClusterId | String | No | dc-2zedxc67zqzt7lb4**** | The ID of the dedicated host cluster. |
SecurityOptions.ConfidentialComputingMode | String | No | TDX | The confidential computing mode. Valid values:
|
HttpEndpoint | String | No | enabled | Specifies whether to enable the access channel for instance metadata. Valid values:
Default value: enabled. Note For information about instance metadata, see Overview of ECS instance metadata. |
HttpTokens | String | No | optional | Specifies whether to enforce the use of the security-hardened mode (IMDSv2) when accessing instance metadata. Valid values:
Default value: optional. Note For information about instance metadata access modes, see Instance metadata access modes. |
ResourcePoolOptions.Strategy | String | No | PrivatePoolFirst | The resource pool includes private pools generated after an elasticity assurance or capacity reservation takes effect, and the public pool, which can be selected when launching an instance. Valid values:
Default value: None. |
ResourcePoolOptions.PrivatePoolIds.N | String | No | eap-bp67acfmxazb4**** | The ID of the private pool. This is the ID of the elasticity assurance or capacity reservation. This parameter accepts only Target mode private pool IDs. N ranges from 1 to 20. |
Response parameters
Parameter | Type | Example | Description |
ScalingConfigurationId | String | asc-bp1ffogfdauy0nu5**** | The ID of the scaling configuration. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | The ID of the request. |
Examples
Sample request
http(s)://ess.aliyuncs.com/?Action=CreateScalingConfiguration
&ScalingGroupId=asg-bp14wlu85wrpchm0****
&ImageId=centos6u5_64_20G_aliaegis****.vhd
&ImageName=image****
&InstanceType=ecs.g6.large
&Cpu=2
&Memory=16
&DeploymentSetId=ds-bp1frxuzdg87zh4pz****
&SecurityGroupId=sg-280ih****
&IoOptimized=optimized
&InternetChargeType=PayByTraffic
&InternetMaxBandwidthIn=10
&InternetMaxBandwidthOut=10
&SystemDisk.Category=cloud_ssd
&SystemDisk.Size=100
&SystemDisk.DiskName=cloud_ssdSystem
&SystemDisk.Description=Test system disk.
&SystemDisk.AutoSnapshotPolicyId=sp-bp12m37ccmxvbmi5****
&SystemDisk.PerformanceLevel=PL1
&ScalingConfigurationName=scalingconfig****
&LoadBalancerWeight=50
&Tags={"key1":"value1","key2":"value2", ... "key5":"value5"}
&UserData=ZWNobyBoZWxsbyBlY3Mh
&KeyPairName=KeyPairTest
&RamRoleName=ramrole****
&SecurityEnhancementStrategy=Active
&InstanceName=instance****
&HostName=host****
&SpotStrategy=NoSpot
&PasswordInherit=false
&Password=123abc****
&ResourceGroupId=rg-resource****
&HpcClusterId=hpc-clusterid
&InstanceDescription=Test instance.
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&Ipv6AddressCount=1
&CreditSpecification=Standard
&ImageFamily=hangzhou-daily-update
&ZoneId=cn-hangzhou-g
&DedicatedHostId=dh-bp67acfmxazb4p****
&Affinity=default
&Tenancy=default
&PrivatePoolOptions.MatchCriteria=Open
&PrivatePoolOptions.Id=eap-bp67acfmxazb4****
&SpotDuration=1
&SpotInterruptionBehavior=Terminate
&InstanceTypes=["ecs.g6.large"]
&InstanceTypeOverride=[{"InstanceType":"ecs.c5.xlarge","WeightedCapacity":4}]
&DataDisk=[{"PerformanceLevel":"PL1","AutoSnapshotPolicyId":"sp-bp19nq9enxqkomib****","Encrypted":"false","Description":"Test data disk.","SnapshotId":"s-280s7****","Categories":["cloud"],"Size":100,"Device":"/dev/xvdb","DiskName":"cloud_ssdData","Category":"cloud_ssd","DeleteWithInstance":true,"KMSKeyId":"0e478b7a-4262-4802-b8cb-00d3fb40****","ProvisionedIops":100,"BurstingEnabled":false}]
&SpotPriceLimit=[{"PriceLimit":0.5,"InstanceType":"ecs.g6.large"}]
&SecurityGroupIds=["sg-bp18kz60mefs****"]
&InstancePatternInfo=[{"Cores":2,"InstanceFamilyLevel":"EnterpriseLevel","MaxPrice":2.0,"Memory":4.0,"ExcludedInstanceType":["ecs.n1.small/ecs.n1.*/*7*"],"Architecture":["X86"],"BurstablePerformance":"Include","InstanceTypeFamilies":["ecs.g6"],"MinimumCpuCoreCount":2,"MaximumCpuCoreCount":4,"GpuSpecs":["NVIDIA V100"],"InstanceCategories":["Compute-optimized with GPU"],"CpuArchitectures":["X86"],"PhysicalProcessorModels":["Intel Xeon(Ice Lake) Platinum 8369B\", \"Intel Xeon(Skylake) Platinum 8163\", … \"Intel Xeon(Cascade Lake) Platinum 8269CY"],"MinimumEniQuantity":2,"MinimumEniPrivateIpAddressQuantity":2,"MinimumEniIpv6AddressQuantity":1,"MinimumInitialCredit":12,"MinimumBaselineCredit":12,"MinimumMemorySize":4.0,"MaximumMemorySize":4.0,"MinimumGpuAmount":2,"MaximumGpuAmount":2}]
&SystemDiskCategories=["cloud"]
&SystemDisk.Encrypted=false
&SystemDisk.KMSKeyId=0e478b7a-4262-4802-b8cb-00d3fb40****
&SystemDisk.EncryptAlgorithm=AES-256
&SystemDisk.ProvisionedIops=100
&SystemDisk.BurstingEnabled=false
&ImageOptions.LoginAsNonRoot=false
&DeletionProtection=false
&StorageSetId=ss-bp67acfmxazb4p****
&StorageSetPartitionNumber=2
&CustomPriorities=[{"InstanceType":"ecs.g6.large","VswitchId":"vsw-bp14zolna43z266bq****"}]
&NetworkInterfaces=[{"InstanceType":"Primary","NetworkInterfaceTrafficMode":"HighPerformance","Ipv6AddressCount":1,"SecurityGroupIds":["sg-uf6ij8dwxh****"]}]
&DedicatedHostClusterId=dc-2zedxc67zqzt7lb4****
&SecurityOptions={"ConfidentialComputingMode":"TDX"}
&HttpEndpoint=enabled
&HttpTokens=optional
&ResourcePoolOptions={"Strategy":"PrivatePoolFirst","PrivatePoolIds":["eap-bp67acfmxazb4****"]}
&<Common request parameters>Sample success response
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateScalingConfigurationResponse>
<ScalingConfigurationId>asc-bp1ffogfdauy0nu5****</ScalingConfigurationId>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</CreateScalingConfigurationResponse>JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"ScalingConfigurationId" : "asc-bp1ffogfdauy0nu5****",
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}Error codes
For more information about error codes, see the Error Center.
HTTP status code | Error code | Error message | Description |
400 | InstanceType.Mismatch | The specified scaling configuration and existing active scaling configuration have different instance type. | The instance type of the specified scaling configuration does not match the instance type of the current scaling configuration. |
404 | InvalidDataDiskSnapshotId.NotFound | Snapshot "XXX" does not exist. | The specified snapshot does not exist. |
400 | InvalidDataDiskSnapshotId.SizeNotSupported | The capacity of snapshot "XXX" exceeds the size limit of the specified disk category. | The size of the specified snapshot exceeds the disk size limit. |
403 | InvalidDevice.InUse | Device "XXX" has been occupied. | The mount point of the data disk is already in use. |
400 | InvalidImageId.InstanceTypeMismatch | The specified image does not support the specified instance type. | The specified image cannot be used with the specified instance type. |
404 | InvalidImageId.NotFound | The specified image does not exist. | The specified image does not exist under this account. |
400 | InvalidKeyPairName.NotFound | The specified KeyPairName does not exist in our records. | The specified KeyPairName does not exist. |
400 | InvalidNetworkType.ForRAMRole | RAMRole can't be used For classic instance. | The RamRoleName parameter is not supported for instances in the classic network. |
400 | InvalidParameter | The specified value of parameter KeyPairName is not valid. | The KeyPairName parameter is not supported for Windows. |
400 | InvalidParameter.Conflict | The value of parameter SystemDisk.Category and parameter DataDisk.N.Category are conflict. | The specified system disk type conflicts with the data disk type. |
400 | InvalidRamRole.NotFound | The specified RamRoleName does not exist. | The specified RamRoleName does not exist. |
400 | InvalidScalingConfigurationName.Duplicate | The specified value of parameter ScalingConfigurationName is duplicated. | A scaling configuration with the same name already exists. |
404 | InvalidScalingGroupId.NotFound | The specified scaling group does not exist. | The specified scaling group does not exist under this account. |
400 | InvalidSecurityGroupId.IncorrectNetworkType | The network type of specified security Group does not support this action. | The network type of the specified security group is inconsistent with the network type specified for the scaling group. |
404 | InvalidSecurityGroupId.NotFound | The specified security group does not exist. | The specified security group does not exist under this account. |
400 | InvalidSecurityGroupId.VPCMismatch | The specified security group and the specified virtual switch are not in the same VPC. | The specified security group and virtual switch do not belong to the same VPC. |
403 | InvalidSnapshot.TooOld | This operation is denied because the specified snapshot is created before 2013-07-15. | The snapshot was created on or before July 15, 2013, and the call is rejected. |
403 | InvalidSystemDiskCategory.ValueUnauthorized | The system disk category is not authorized. | You do not have permission to create a system disk of the ephemeral disk type. |
400 | InvalidUserData.Base64FormatInvalid | The specified parameter UserData must be base64 encoded. | The UserData is not Base64-encoded. |
400 | InvalidUserData.SizeExceeded | The specified parameter UserData exceeds the size. | The specified UserData is too long. |
403 | QuotaExceeded.EphemeralDiskSize | Ephemeral disk size quota exceeded. | The total capacity of ephemeral data disks exceeds 2 TiB (2,048 GiB). |
400 | QuotaExceeded.ScalingConfiguration | Scaling configuration quota exceeded in the specified scaling group. | The number of scaling configurations you own has reached the upper limit. |
400 | QuotaExceeded.SecurityGroupInstance | Instance quota exceeded in the specified security group. | The number of ECS instances added to the specified security group has reached the upper limit. |
400 | InvalidSecurityGroupId.IncorrectType | The managed security group "XXX" is not supported. | The managed security group "XXX" is not supported. |